java.lang.ObjectNode
CompositeNode
com.aspose.words.Paragraph
public class Paragraph
The complete list of child nodes that can occur inside a paragraph consists of
A valid paragraph in Microsoft Word always ends with a paragraph break character and
a minimal valid paragraph consists just of a paragraph break. The Paragraph
class automatically appends the appropriate paragraph break character at the end
and this character is not part of the child nodes of the Paragraph, therefore
a Paragraph can be empty. Do not include the end of paragraph
Constructor Summary |
---|
Paragraph(DocumentBase doc)
Initializes a new instance of the Paragraph class. |
Property Getters/Setters Summary | ||
---|---|---|
NodeCollection | getChildNodes() | → inherited from CompositeNode |
Gets all immediate child nodes of this node. | ||
int | getCount() | → inherited from CompositeNode |
Gets the number of immediate children of this node. | ||
DocumentBase | getDocument() | → inherited from Node |
Gets the document to which this node belongs. | ||
Node | getFirstChild() | → inherited from CompositeNode |
Gets the first child of the node. | ||
FrameFormat | getFrameFormat() | |
Provides access to the paragraph formatting properties. | ||
boolean | hasChildNodes() | → inherited from CompositeNode |
Returns true if this node has any child nodes. | ||
boolean | isComposite() | → inherited from CompositeNode |
Returns true as this node can have child nodes. | ||
boolean | isDeleteRevision() | |
Returns true if this object was deleted in Microsoft Word while change tracking was enabled. | ||
boolean | isEndOfCell() | |
True if this paragraph is the last paragraph in a |
||
boolean | isEndOfDocument() | |
True if this paragraph is the last paragraph in the last section of the document. | ||
boolean | isEndOfHeaderFooter() | |
True if this paragraph is the last paragraph in the HeaderFooter (main text story) of a Section; false otherwise. | ||
boolean | isEndOfSection() | |
True if this paragraph is the last paragraph in the Body (main text story) of a Section; false otherwise. | ||
boolean | isFormatRevision() | |
Returns true if formatting of the object was changed in Microsoft Word while change tracking was enabled. | ||
boolean | isInCell() | |
True if this paragraph is an immediate child of |
||
boolean | isInsertRevision() | |
Returns true if this object was inserted in Microsoft Word while change tracking was enabled. | ||
boolean | isListItem() | |
True when the paragraph is an item in a bulleted or numbered list in original revision. | ||
Node | getLastChild() | → inherited from CompositeNode |
Gets the last child of the node. | ||
ListFormat | getListFormat() | |
Provides access to the list formatting properties of the paragraph. | ||
Aspose.Words.Lists.ListLabel | getListLabel() | |
Gets a |
||
Node | getNextSibling() | → inherited from Node |
Gets the node immediately following this node. | ||
int | getNodeType() | |
Returns NodeType.Paragraph. The value of the property is NodeType integer constant. | ||
Font | getParagraphBreakFont() | |
Provides access to the font formatting of the paragraph break character. | ||
ParagraphFormat | getParagraphFormat() | |
Provides access to the paragraph formatting properties. | ||
CompositeNode | getParentNode() | → inherited from Node |
Gets the immediate parent of this node. | ||
Section | getParentSection() | |
Retrieves the parent |
||
Story | getParentStory() | |
Retrieves the parent section-level story that can be |
||
Node | getPreviousSibling() | → inherited from Node |
Gets the node immediately preceding this node. | ||
Range | getRange() | → inherited from Node |
Returns a Range object that represents the portion of a document that is contained in this node. | ||
RunCollection | getRuns() | |
Provides access to the typed collection of pieces of text inside the paragraph. |
Method Summary | ||
---|---|---|
boolean | accept(DocumentVisitor visitor) | |
Accepts a visitor. | ||
Node | appendChild(Node newChild) | → inherited from CompositeNode |
Adds the specified node to the end of the list of child nodes for this node. | ||
Aspose.Words.Fields.Field | appendField(java.lang.String fieldCode) | |
Appends a field to this paragraph. | ||
Aspose.Words.Fields.Field | appendField(java.lang.String fieldCode, java.lang.String fieldValue) | |
Appends a field to this paragraph. | ||
void | clearParaAttrs() | |
Reserved for internal use. | ||
void | clearRunAttrs() | |
Reserved for internal use. | ||
Node | deepClone(boolean isCloneChildren) | → inherited from Node |
Creates a duplicate of the node. | ||
java.lang.Object | fetchInheritedParaAttr(int key) | |
Reserved for internal use. | ||
java.lang.Object | fetchInheritedRunAttr(int key) | |
Reserved for internal use. | ||
java.lang.Object | fetchParaAttr(int key) | |
Reserved for internal use. | ||
CompositeNode | getAncestor(int ancestorType) | → inherited from Node |
Gets the first ancestor of the specified |
||
CompositeNode | getAncestor(java.lang.Class ancestorType) | → inherited from Node |
Gets the first ancestor of the specified object type. | ||
Node | getChild(int nodeType, int index, boolean isDeep) | → inherited from CompositeNode |
Returns an Nth child node that matches the specified type. | ||
NodeCollection | getChildNodes(int nodeType, boolean isDeep) | → inherited from CompositeNode |
Returns a live collection of child nodes that match the specified type. | ||
CompositeNode | getContainer() | → inherited from CompositeNode |
Reserved for internal use. | ||
aspose.obfuscated.type | getDeleteRevision() | |
Reserved for internal use. | ||
java.lang.Object | getDirectParaAttr(int key) | |
Reserved for internal use. | ||
int | getDirectParaAttrsCount() | |
Reserved for internal use. | ||
int | getDirectParaKey(int index) | |
Reserved for internal use. | ||
java.lang.Object | getDirectRunAttr(int key) | |
Reserved for internal use. | ||
int | getDirectRunAttrsCount() | |
Reserved for internal use. | ||
Aspose.Words.TabStop[] | getEffectiveTabStops() | |
Returns array of all tab stops applied to this paragraph, including applied indirectly by styles or lists. | ||
aspose.obfuscated.type | getInsertRevision() | |
Reserved for internal use. | ||
aspose.obfuscated.type | getMoveFromRevision() | |
Reserved for internal use. | ||
aspose.obfuscated.type | getMoveToRevision() | |
Reserved for internal use. | ||
Node | getNextMatchingNode(aspose.obfuscated.type curNode) | → inherited from CompositeNode |
Reserved for internal use. | ||
java.lang.String | getText() | |
Gets the text of this paragraph including the end of paragraph character. | ||
int | indexOf(Node child) | → inherited from CompositeNode |
Returns the index of the specified child node in the child node array. | ||
Node | insertAfter(Node newChild, Node refChild) | → inherited from CompositeNode |
Inserts the specified node immediately after the specified reference node. | ||
Node | insertBefore(Node newChild, Node refChild) | → inherited from CompositeNode |
Inserts the specified node immediately before the specified reference node. | ||
Aspose.Words.Fields.Field | insertField(java.lang.String fieldCode, Node refNode, boolean isAfter) | |
Inserts a field into this paragraph. | ||
Aspose.Words.Fields.Field | insertField(java.lang.String fieldCode, java.lang.String fieldValue, Node refNode, boolean isAfter) | |
Inserts a field into this paragraph. | ||
java.util.Iterator | iterator() | → inherited from CompositeNode |
Provides support for the for each style iteration over the child nodes of this node. | ||
int | joinRunsWithSameFormatting() | |
Joins runs with the same formatting in the paragraph. | ||
Node | nextPreOrder(Node rootNode) | → inherited from Node |
Gets next node according to the pre-order tree traversal algorithm. | ||
Node | prependChild(Node newChild) | → inherited from CompositeNode |
Adds the specified node to the beginning of the list of child nodes for this node. | ||
Node | previousPreOrder(Node rootNode) | → inherited from Node |
Gets the previous node according to the pre-order tree traversal algorithm. | ||
void | remove() | → inherited from Node |
Removes itself from the parent. | ||
void | removeAllChildren() | → inherited from CompositeNode |
Removes all the child nodes of the current node. | ||
Node | removeChild(Node oldChild) | → inherited from CompositeNode |
Removes the specified child node. | ||
void | removeParaAttr(int key) | |
Reserved for internal use. | ||
void | removeRunAttr(int key) | |
Reserved for internal use. | ||
void | removeSmartTags() | → inherited from CompositeNode |
Removes all |
||
NodeList | selectNodes(java.lang.String xpath) | → inherited from CompositeNode |
Selects a list of nodes matching the XPath expression. | ||
Node | selectSingleNode(java.lang.String xpath) | → inherited from CompositeNode |
Selects the first Node that matches the XPath expression. | ||
void | setDeleteRevision(aspose.obfuscated.type value) | |
Reserved for internal use. | ||
void | setInsertRevision(aspose.obfuscated.type value) | |
Reserved for internal use. | ||
void | setMoveFromRevision(aspose.obfuscated.type value) | |
Reserved for internal use. | ||
void | setMoveToRevision(aspose.obfuscated.type value) | |
Reserved for internal use. | ||
void | setParaAttr(int key, java.lang.Object value) | |
Reserved for internal use. | ||
void | setRunAttr(int key, java.lang.Object value) | |
Reserved for internal use. | ||
java.lang.String | toString(int saveFormat) | → inherited from Node |
Exports the content of the node into a string in the specified format. | ||
java.lang.String | toTxt() | → inherited from Node |
Exports the content of the node into a string in plain text format. |
Constructor Detail |
---|
public Paragraph(DocumentBase doc)
When Paragraph is created, it belongs to the specified document, but is not yet part of the document and ParentNode is null.
To append Paragraph to the document use InsertAfter or InsertBefore on the story where you want the paragraph inserted.
doc
- The owner document.Property Getters/Setters Detail |
---|
getChildNodes | → inherited from CompositeNode |
public NodeCollection getChildNodes() |
Note, GetChildNodes(NodeType.Any, false)
and creates and returns a new collection every time it is accessed.
If there are no child nodes, this property returns an empty collection.
getCount | → inherited from CompositeNode |
public int getCount() |
getDocument | → inherited from Node |
public DocumentBase getDocument() |
The node always belongs to a document even if it has just been created and not yet added to the tree, or if it has been removed from the tree.
getFirstChild | → inherited from CompositeNode |
public Node getFirstChild() |
getFrameFormat | |
public FrameFormat getFrameFormat() |
hasChildNodes | → inherited from CompositeNode |
public boolean hasChildNodes() |
isComposite | → inherited from CompositeNode |
public boolean isComposite() |
isDeleteRevision | |
public boolean isDeleteRevision() |
isEndOfCell | |
public boolean isEndOfCell() |
isEndOfDocument | |
public boolean isEndOfDocument() |
isEndOfHeaderFooter | |
public boolean isEndOfHeaderFooter() |
isEndOfSection | |
public boolean isEndOfSection() |
isFormatRevision | |
public boolean isFormatRevision() |
isInCell | |
public boolean isInCell() |
isInsertRevision | |
public boolean isInsertRevision() |
isListItem | |
public boolean isListItem() |
getLastChild | → inherited from CompositeNode |
public Node getLastChild() |
getListFormat | |
public ListFormat getListFormat() |
getListLabel | |
public Aspose.Words.Lists.ListLabel getListLabel() |
getNextSibling | → inherited from Node |
public Node getNextSibling() |
getNodeType | |
public int getNodeType() |
getParagraphBreakFont | |
public Font getParagraphBreakFont() |
getParagraphFormat | |
public ParagraphFormat getParagraphFormat() |
getParentNode | → inherited from Node |
public CompositeNode getParentNode() |
If a node has just been created and not yet added to the tree, or if it has been removed from the tree, the parent is null.
getParentSection | |
public Section getParentSection() |
getParentStory | |
public Story getParentStory() |
getPreviousSibling | → inherited from Node |
public Node getPreviousSibling() |
getRange | → inherited from Node |
public Range getRange() |
getRuns | |
public RunCollection getRuns() |
Method Detail |
---|
accept | |
public boolean accept(DocumentVisitor visitor) throws java.lang.Exception |
Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.
For more info see the Visitor design pattern.
visitor
- The visitor that will visit the nodes.appendChild | → inherited from CompositeNode |
public Node appendChild(Node newChild) |
If the newChild is already in the tree, it is first removed.
If the node being inserted was created from another document, you should use
newChild
- The node to add.appendField | |
public Aspose.Words.Fields.Field appendField(java.lang.String fieldCode) throws java.lang.Exception |
fieldCode
- The field code to append (without curly braces).appendField | |
public Aspose.Words.Fields.Field appendField(java.lang.String fieldCode, java.lang.String fieldValue) |
fieldCode
- The field code to append (without curly braces).fieldValue
- The field value to append. Pass null for fields that do not have a value.clearParaAttrs | |
public void clearParaAttrs() |
clearRunAttrs | |
public void clearRunAttrs() |
deepClone | → inherited from Node |
public Node deepClone(boolean isCloneChildren) |
This method serves as a copy constructor for nodes. The cloned node has no parent, but belongs to the same document as the original node.
This method always performs a deep copy of the node. The isCloneChildren parameter specifies whether to perform copy all child nodes as well.
isCloneChildren
- True to recursively clone the subtree under the specified node;
false to clone only the node itself.fetchInheritedParaAttr | |
public java.lang.Object fetchInheritedParaAttr(int key) |
fetchInheritedRunAttr | |
public java.lang.Object fetchInheritedRunAttr(int key) |
fetchParaAttr | |
public java.lang.Object fetchParaAttr(int key) |
getAncestor | → inherited from Node |
public CompositeNode getAncestor(int ancestorType) |
ancestorType
- A getAncestor | → inherited from Node |
public CompositeNode getAncestor(java.lang.Class ancestorType) |
The ancestor type matches if it is equal to ancestorType or derived from ancestorType.
ancestorType
- The object type of the ancestor to retrieve.getChild | → inherited from CompositeNode |
public Node getChild(int nodeType, int index, boolean isDeep) |
If index is out of range, a null is returned.
nodeType
- A index
- Zero based index of the child node to select.
Negative indexes are also allowed and indicate access from the end,
that is -1 means the last node.isDeep
- True to select from all child nodes recursively.
False to select only among immediate children. See remarks for more info.getChildNodes | → inherited from CompositeNode |
public NodeCollection getChildNodes(int nodeType, boolean isDeep) |
The collection of nodes returned by this method is always live.
A live collection is always in sync with the document. For example, if you selected all sections in a document and enumerate through the collection deleting the sections, the section is removed from the collection immediately when it is removed from the document.
nodeType
- A isDeep
- True to select from all child nodes recursively.
False to select only among immediate children. getContainer | → inherited from CompositeNode |
public CompositeNode getContainer() |
getDeleteRevision | |
public aspose.obfuscated.type getDeleteRevision() |
getDirectParaAttr | |
public java.lang.Object getDirectParaAttr(int key) |
getDirectParaAttrsCount | |
public int getDirectParaAttrsCount() |
getDirectParaKey | |
public int getDirectParaKey(int index) |
getDirectRunAttr | |
public java.lang.Object getDirectRunAttr(int key) |
getDirectRunAttrsCount | |
public int getDirectRunAttrsCount() |
getEffectiveTabStops | |
public Aspose.Words.TabStop[] getEffectiveTabStops() |
getInsertRevision | |
public aspose.obfuscated.type getInsertRevision() |
getMoveFromRevision | |
public aspose.obfuscated.type getMoveFromRevision() |
getMoveToRevision | |
public aspose.obfuscated.type getMoveToRevision() |
getNextMatchingNode | → inherited from CompositeNode |
public Node getNextMatchingNode(aspose.obfuscated.type curNode) |
getText | |
public java.lang.String getText() |
The text of all child nodes is concatenated and the end of paragraph character is appended as follows:
The returned string includes all control and special characters as described in
indexOf | → inherited from CompositeNode |
public int indexOf(Node child) |
insertAfter | → inherited from CompositeNode |
public Node insertAfter(Node newChild, Node refChild) |
If refChild is null, inserts newChild at the beginning of the list of child nodes.
If the newChild is already in the tree, it is first removed.
If the node being inserted was created from another document, you should use
newChild
- The Node to insert.refChild
- The Node that is the reference node. The newNode is placed after the refNode. insertBefore | → inherited from CompositeNode |
public Node insertBefore(Node newChild, Node refChild) |
If refChild is null, inserts newChild at the end of the list of child nodes.
If the newChild is already in the tree, it is first removed.
If the node being inserted was created from another document, you should use
newChild
- The Node to insert.refChild
- The Node that is the reference node. The newChild is placed before this node.insertField | |
public Aspose.Words.Fields.Field insertField(java.lang.String fieldCode, Node refNode, boolean isAfter) throws java.lang.Exception |
fieldCode
- The field code to insert (without curly braces).refNode
- Reference node inside this paragraph (if refNode is null, then appends to the end of the paragraph).isAfter
- Whether to insert the field after or before reference node.insertField | |
public Aspose.Words.Fields.Field insertField(java.lang.String fieldCode, java.lang.String fieldValue, Node refNode, boolean isAfter) |
fieldCode
- The field code to insert (without curly braces).fieldValue
- The field value to insert. Pass null for fields that do not have a value.refNode
- Reference node inside this paragraph (if refNode is null, then appends to the end of the paragraph).isAfter
- Whether to insert the field after or before reference node.iterator | → inherited from CompositeNode |
public java.util.Iterator iterator() |
joinRunsWithSameFormatting | |
public int joinRunsWithSameFormatting() |
nextPreOrder | → inherited from Node |
public Node nextPreOrder(Node rootNode) |
rootNode
- The top node (limit) of traversal.prependChild | → inherited from CompositeNode |
public Node prependChild(Node newChild) |
If the newChild is already in the tree, it is first removed.
If the node being inserted was created from another document, you should use
newChild
- The node to add.previousPreOrder | → inherited from Node |
public Node previousPreOrder(Node rootNode) |
rootNode
- The top node (limit) of traversal.remove | → inherited from Node |
public void remove() |
removeAllChildren | → inherited from CompositeNode |
public void removeAllChildren() |
removeChild | → inherited from CompositeNode |
public Node removeChild(Node oldChild) |
The parent of oldChild is set to null after the node is removed.
oldChild
- The node to remove.removeParaAttr | |
public void removeParaAttr(int key) |
removeRunAttr | |
public void removeRunAttr(int key) |
removeSmartTags | → inherited from CompositeNode |
public void removeSmartTags() |
selectNodes | → inherited from CompositeNode |
public NodeList selectNodes(java.lang.String xpath) |
Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.
xpath
- The XPath expression.selectSingleNode | → inherited from CompositeNode |
public Node selectSingleNode(java.lang.String xpath) |
Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.
xpath
- The XPath expression.setDeleteRevision | |
public void setDeleteRevision(aspose.obfuscated.type value) |
setInsertRevision | |
public void setInsertRevision(aspose.obfuscated.type value) |
setMoveFromRevision | |
public void setMoveFromRevision(aspose.obfuscated.type value) |
setMoveToRevision | |
public void setMoveToRevision(aspose.obfuscated.type value) |
setParaAttr | |
public void setParaAttr(int key, java.lang.Object value) |
setRunAttr | |
public void setRunAttr(int key, java.lang.Object value) |
toString | → inherited from Node |
public java.lang.String toString(int saveFormat) throws java.lang.Exception |
saveFormat
- A SaveFormat value.toTxt | → inherited from Node |
public java.lang.String toTxt() throws java.lang.Exception |
This method removes field codes and Microsoft Word control characters, uses CrLf
(or any other) combination of characters to mark ends of paragraphs in the resulting string.
It produces a different result from