|
ASPOSE home |
java.lang.ObjectNode
CompositeNode
com.aspose.words.Paragraph
public class Paragraph
Paragraph is a block-level node and can be a child of classes derived from
Story or InlineStory. Paragraph can contain any number of inline-level nodes and bookmarks.
The inline nodes include all classes derived from 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(Document 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. | ||
Document | getDocument() | → inherited from Node |
Gets the document to which this node belongs. | ||
Node | getFirstChild() | → inherited from CompositeNode |
Gets the first child of the node. | ||
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 Cell; false otherwise. | ||
boolean | isEndOfDocument() | |
True if this paragraph is the last paragraph in the last section of the document. | ||
boolean | isEndOfSection() | |
True if this paragraph is the last paragraph in the Body (main text story) of a Section; false otherwise. | ||
boolean | isInCell() | |
True if this paragraph is an immediate child of Cell; false otherwise. | ||
boolean | isInsertRevision() | |
Returns true if this object was deleted in Microsoft Word while change tracking was enabled. | ||
boolean | isListItem() | |
True when the paragraph is an item in a bulleted or numbered list. | ||
Node | getLastChild() | → inherited from CompositeNode |
Gets the last child of the node. | ||
ListFormat | getListFormat() | |
Provides access to the list formatting properties of the paragraph. | ||
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 Section of the paragraph. | ||
Story | getParentStory() | |
Retrieves the parent section-level story that can be Body or HeaderFooter. | ||
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. | ||
Runs | 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. | ||
void | clearParaAttrs() | |
Reserved for internal use. | ||
void | clearRunAttrs() | |
Reserved for internal use. | ||
Node | deepClone(boolean isCloneChildren) | |
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. | ||
Node | getAncestor(java.lang.Class ancestorType) | → inherited from Node |
Gets the first ancestor of the specified 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. | ||
NodeCollection | getChildNodes(int nodeType, boolean isDeep, boolean isLive) | → inherited from CompositeNode |
Returns a "live" or "snapshot" collection of child node that match the specified type. | ||
java.lang.Object | getDirectParaAttr(int key) | |
Reserved for internal use. | ||
java.lang.Object | getDirectRunAttr(int key) | |
Reserved for internal use. | ||
Aspose.Words.ParaPr | getParaPr() | |
Reserved for internal use. | ||
Aspose.Words.RunPr | getRunPr() | |
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. | ||
java.util.Iterator | iterator() | → inherited from CompositeNode |
Provides support for the for each style iteration over the child nodes of this node. | ||
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. | ||
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 | 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 | toTxt() | → inherited from Node |
Exports the content of the node into a string in TXT (plain text) format. |
Constructor Detail |
---|
public Paragraph(Document 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 |
---|
getNodeType | |
public int getNodeType() |
getParentStory | |
public Story getParentStory() |
getParentSection | |
public Section getParentSection() |
isInCell | |
public boolean isInCell() |
isEndOfCell | |
public boolean isEndOfCell() |
isEndOfSection | |
public boolean isEndOfSection() |
isEndOfDocument | |
public boolean isEndOfDocument() |
getParagraphFormat | |
public ParagraphFormat getParagraphFormat() |
getListFormat | |
public ListFormat getListFormat() |
getRuns | |
public Runs getRuns() |
getParagraphBreakFont | |
public Font getParagraphBreakFont() |
isInsertRevision | |
public boolean isInsertRevision() |
isDeleteRevision | |
public boolean isDeleteRevision() |
isListItem | |
public boolean isListItem() |
isComposite | → inherited from CompositeNode |
public boolean isComposite() |
hasChildNodes | → inherited from CompositeNode |
public boolean hasChildNodes() |
getChildNodes | → inherited from CompositeNode |
public NodeCollection getChildNodes() |
If there are no child nodes, this property returns an empty collection.
ChildNodes is equivalent to calling GetChildNodes(NodeType.Any, false)
.
getFirstChild | → inherited from CompositeNode |
public Node getFirstChild() |
getLastChild | → inherited from CompositeNode |
public Node getLastChild() |
getCount | → inherited from CompositeNode |
public int getCount() |
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.
getDocument | → inherited from Node |
public Document getDocument() |
The node always belongs to a document even if it has just been created and not yed added to the tree, or if it has been removed from the tree.
getPreviousSibling | → inherited from Node |
public Node getPreviousSibling() |
If there is no preceding node, a null is returned.
Note: Calculating the value of this property iterates from the first child node of ParenNode to this node.
getNextSibling | → inherited from Node |
public Node getNextSibling() |
getRange | → inherited from Node |
public Range getRange() |
Method Detail |
---|
iterator | → inherited from CompositeNode |
public java.util.Iterator iterator() |
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
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.deepClone | |
public Node deepClone(boolean isCloneChildren) throws java.lang.Exception |
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.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. getChildNodes | → inherited from CompositeNode |
public NodeCollection getChildNodes(int nodeType, boolean isDeep, boolean isLive) |
Snapshot collections require less resources than live collections because a snapshot collection of nodes is not updated when the document is changed.
Snapshot collections are useful for tasks, that do not require immediate update of the collection when the document is changed. For example, select all shapes and delete them is more efficient using a snapshot collection.
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. isLive
- True to return a live collection; false to return a snapshot collection.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. selectNodes | → inherited from CompositeNode |
public NodeList selectNodes(java.lang.String xpath) throws org.jaxen.JaxenException |
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) throws org.jaxen.JaxenException |
Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.
xpath
- The XPath expression.appendChild | → inherited from CompositeNode |
public Node appendChild(Node newChild) throws java.lang.Exception |
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.prependChild | → inherited from CompositeNode |
public Node prependChild(Node newChild) throws java.lang.Exception |
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.insertAfter | → inherited from CompositeNode |
public Node insertAfter(Node newChild, Node refChild) throws java.lang.Exception |
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) throws java.lang.Exception |
If refChild is null, inserts newChild at the end of the list of child nodes.
Note: InsertBefore could be slower than InsertAfter because it needs to iterate over all nodes from the first child to the reference node.
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.removeChild | → inherited from CompositeNode |
public Node removeChild(Node oldChild) throws java.lang.Exception |
The parent of oldChild is set to null after the node is removed.
oldChild
- The node to remove.removeAllChildren | → inherited from CompositeNode |
public void removeAllChildren() throws java.lang.Exception |
indexOf | → inherited from CompositeNode |
public int indexOf(Node child) |
getAncestor | → inherited from Node |
public Node getAncestor(java.lang.Class ancestorType) |
The ancestor type matches if it is equal to ancestorType or derived from ancestorType.
ancestorType
- The type of the ancestor to retrieve.remove | → inherited from Node |
public void remove() throws java.lang.Exception |
nextPreOrder | → inherited from Node |
public Node nextPreOrder(Node rootNode) |
rootNode
- The top node (limit) of traversal.previousPreOrder | → inherited from Node |
public Node previousPreOrder(Node rootNode) |
rootNode
- The top node (limit) of traversal.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 combination
to mark ends of paragraphs in the resulting string. It produces a different result from
getRunPr | |
public Aspose.Words.RunPr getRunPr() |
getParaPr | |
public Aspose.Words.ParaPr getParaPr() |
clearRunAttrs | |
public void clearRunAttrs() |
setRunAttr | |
public void setRunAttr(int key, java.lang.Object value) |
fetchInheritedRunAttr | |
public java.lang.Object fetchInheritedRunAttr(int key) throws java.lang.Exception |
getDirectRunAttr | |
public java.lang.Object getDirectRunAttr(int key) |
clearParaAttrs | |
public void clearParaAttrs() |
setParaAttr | |
public void setParaAttr(int key, java.lang.Object value) |
fetchInheritedParaAttr | |
public java.lang.Object fetchInheritedParaAttr(int key) throws java.lang.Exception |
getDirectParaAttr | |
public java.lang.Object getDirectParaAttr(int key) throws java.lang.Exception |
|
ASPOSE home |