com.aspose.words
Class Paragraph

java.lang.Object
  extended by Node
      extended by CompositeNode
          extended by com.aspose.words.Paragraph
All Implemented Interfaces:
java.lang.Iterable, java.lang.Cloneable

public class Paragraph 
extends CompositeNode

Represents a paragraph of text.

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 complete list of child nodes that can occur inside a paragraph consists of BookmarkStart, BookmarkEnd, Aspose.Words.Fields.FieldStart, Aspose.Words.Fields.FieldSeparator, Aspose.Words.Fields.FieldEnd, Aspose.Words.Fields.FormField, Comment, Footnote, Run, SpecialChar, Shape, GroupShape, Aspose.Words.Markup.SmartTag.

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 ControlChar.PARAGRAPH_BREAK or end of cell ControlChar.CELL characters inside the text of the paragraph as it might make the paragraph invalid when the document is opened in Microsoft Word.


Constructor Summary
Paragraph(DocumentBase doc)
           Initializes a new instance of the Paragraph class.
 
Property Getters/Setters Summary
NodeCollectiongetChildNodes()→ inherited from CompositeNode
           Gets all immediate child nodes of this node.
intgetCount()→ inherited from CompositeNode
           Gets the number of immediate children of this node.
DocumentBasegetDocument()→ inherited from Node
           Gets the document to which this node belongs.
NodegetFirstChild()→ inherited from CompositeNode
           Gets the first child of the node.
FrameFormatgetFrameFormat()
           Provides access to the paragraph formatting properties.
booleanhasChildNodes()→ inherited from CompositeNode
           Returns true if this node has any child nodes.
booleanisComposite()→ inherited from CompositeNode
           Returns true as this node can have child nodes.
booleanisDeleteRevision()
           Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
booleanisEndOfCell()
           True if this paragraph is the last paragraph in a Aspose.Words.Tables.Cell; false otherwise.
booleanisEndOfDocument()
           True if this paragraph is the last paragraph in the last section of the document.
booleanisEndOfHeaderFooter()
           True if this paragraph is the last paragraph in the HeaderFooter (main text story) of a Section; false otherwise.
booleanisEndOfSection()
           True if this paragraph is the last paragraph in the Body (main text story) of a Section; false otherwise.
booleanisFormatRevision()
           Returns true if formatting of the object was changed in Microsoft Word while change tracking was enabled.
booleanisInCell()
           True if this paragraph is an immediate child of Aspose.Words.Tables.Cell; false otherwise.
booleanisInsertRevision()
           Returns true if this object was inserted in Microsoft Word while change tracking was enabled.
booleanisListItem()
           True when the paragraph is an item in a bulleted or numbered list in original revision.
NodegetLastChild()→ inherited from CompositeNode
           Gets the last child of the node.
ListFormatgetListFormat()
           Provides access to the list formatting properties of the paragraph.
Aspose.Words.Lists.ListLabelgetListLabel()
           Gets a ListLabel object that provides access to list numbering value and formatting for this paragraph.
NodegetNextSibling()→ inherited from Node
           Gets the node immediately following this node.
intgetNodeType()
           Returns NodeType.Paragraph. The value of the property is NodeType integer constant.
FontgetParagraphBreakFont()
           Provides access to the font formatting of the paragraph break character.
ParagraphFormatgetParagraphFormat()
           Provides access to the paragraph formatting properties.
CompositeNodegetParentNode()→ inherited from Node
           Gets the immediate parent of this node.
SectiongetParentSection()
           Retrieves the parent Section of the paragraph.
StorygetParentStory()
           Retrieves the parent section-level story that can be Body or HeaderFooter.
NodegetPreviousSibling()→ inherited from Node
           Gets the node immediately preceding this node.
RangegetRange()→ inherited from Node
           Returns a Range object that represents the portion of a document that is contained in this node.
RunCollectiongetRuns()
           Provides access to the typed collection of pieces of text inside the paragraph.
 
Method Summary
booleanaccept(DocumentVisitor visitor)
           Accepts a visitor.
NodeappendChild(Node newChild)→ inherited from CompositeNode
           Adds the specified node to the end of the list of child nodes for this node.
Aspose.Words.Fields.FieldappendField(java.lang.String fieldCode)
           Appends a field to this paragraph.
Aspose.Words.Fields.FieldappendField(java.lang.String fieldCode, java.lang.String fieldValue)
           Appends a field to this paragraph.
voidclearParaAttrs()
          Reserved for internal use.
voidclearRunAttrs()
          Reserved for internal use.
NodedeepClone(boolean isCloneChildren)→ inherited from Node
           Creates a duplicate of the node.
java.lang.ObjectfetchInheritedParaAttr(int key)
          Reserved for internal use.
java.lang.ObjectfetchInheritedRunAttr(int key)
          Reserved for internal use.
java.lang.ObjectfetchParaAttr(int key)
          Reserved for internal use.
CompositeNodegetAncestor(int ancestorType)→ inherited from Node
           Gets the first ancestor of the specified NodeType.
CompositeNodegetAncestor(java.lang.Class ancestorType)→ inherited from Node
           Gets the first ancestor of the specified object type.
NodegetChild(int nodeType, int index, boolean isDeep)→ inherited from CompositeNode
           Returns an Nth child node that matches the specified type.
NodeCollectiongetChildNodes(int nodeType, boolean isDeep)→ inherited from CompositeNode
           Returns a live collection of child nodes that match the specified type.
CompositeNodegetContainer()→ inherited from CompositeNode
          Reserved for internal use.
aspose.obfuscated.typegetDeleteRevision()
          Reserved for internal use.
java.lang.ObjectgetDirectParaAttr(int key)
          Reserved for internal use.
intgetDirectParaAttrsCount()
          Reserved for internal use.
intgetDirectParaKey(int index)
          Reserved for internal use.
java.lang.ObjectgetDirectRunAttr(int key)
          Reserved for internal use.
intgetDirectRunAttrsCount()
          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.typegetInsertRevision()
          Reserved for internal use.
aspose.obfuscated.typegetMoveFromRevision()
          Reserved for internal use.
aspose.obfuscated.typegetMoveToRevision()
          Reserved for internal use.
NodegetNextMatchingNode(aspose.obfuscated.type curNode)→ inherited from CompositeNode
          Reserved for internal use.
java.lang.StringgetText()
           Gets the text of this paragraph including the end of paragraph character.
intindexOf(Node child)→ inherited from CompositeNode
           Returns the index of the specified child node in the child node array.
NodeinsertAfter(Node newChild, Node refChild)→ inherited from CompositeNode
           Inserts the specified node immediately after the specified reference node.
NodeinsertBefore(Node newChild, Node refChild)→ inherited from CompositeNode
           Inserts the specified node immediately before the specified reference node.
Aspose.Words.Fields.FieldinsertField(java.lang.String fieldCode, Node refNode, boolean isAfter)
           Inserts a field into this paragraph.
Aspose.Words.Fields.FieldinsertField(java.lang.String fieldCode, java.lang.String fieldValue, Node refNode, boolean isAfter)
           Inserts a field into this paragraph.
java.util.Iteratoriterator()→ inherited from CompositeNode
           Provides support for the for each style iteration over the child nodes of this node.
intjoinRunsWithSameFormatting()
           Joins runs with the same formatting in the paragraph.
NodenextPreOrder(Node rootNode)→ inherited from Node
           Gets next node according to the pre-order tree traversal algorithm.
NodeprependChild(Node newChild)→ inherited from CompositeNode
           Adds the specified node to the beginning of the list of child nodes for this node.
NodepreviousPreOrder(Node rootNode)→ inherited from Node
           Gets the previous node according to the pre-order tree traversal algorithm.
voidremove()→ inherited from Node
           Removes itself from the parent.
voidremoveAllChildren()→ inherited from CompositeNode
           Removes all the child nodes of the current node.
NoderemoveChild(Node oldChild)→ inherited from CompositeNode
           Removes the specified child node.
voidremoveParaAttr(int key)
          Reserved for internal use.
voidremoveRunAttr(int key)
          Reserved for internal use.
voidremoveSmartTags()→ inherited from CompositeNode
           Removes all Aspose.Words.Markup.SmartTag descendant nodes of the current node.
NodeListselectNodes(java.lang.String xpath)→ inherited from CompositeNode
           Selects a list of nodes matching the XPath expression.
NodeselectSingleNode(java.lang.String xpath)→ inherited from CompositeNode
           Selects the first Node that matches the XPath expression.
voidsetDeleteRevision(aspose.obfuscated.type value)
          Reserved for internal use.
voidsetInsertRevision(aspose.obfuscated.type value)
          Reserved for internal use.
voidsetMoveFromRevision(aspose.obfuscated.type value)
          Reserved for internal use.
voidsetMoveToRevision(aspose.obfuscated.type value)
          Reserved for internal use.
voidsetParaAttr(int key, java.lang.Object value)
          Reserved for internal use.
voidsetRunAttr(int key, java.lang.Object value)
          Reserved for internal use.
java.lang.StringtoString(int saveFormat)→ inherited from Node
           Exports the content of the node into a string in the specified format.
java.lang.StringtoTxt()→ inherited from Node
           Exports the content of the node into a string in plain text format.
 

Constructor Detail

Paragraph

public Paragraph(DocumentBase doc)
Initializes a new instance of the Paragraph class.

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.

Parameters:
doc - The owner document.

Property Getters/Setters Detail

getChildNodes

→ inherited from CompositeNode
public NodeCollection getChildNodes()
Gets all immediate child nodes of this node.

Note, ChildNodes is equivalent to calling 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()
Gets the number of immediate children of this node.

getDocument

→ inherited from Node
public DocumentBase getDocument()
Gets the document to which this node belongs.

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()
Gets the first child of the node. If there is no first child node, a null is returned.

getFrameFormat

public FrameFormat getFrameFormat()
Provides access to the paragraph formatting properties.

hasChildNodes

→ inherited from CompositeNode
public boolean hasChildNodes()
Returns true if this node has any child nodes.

isComposite

→ inherited from CompositeNode
public boolean isComposite()
Returns true as this node can have child nodes.

isDeleteRevision

public boolean isDeleteRevision()
Returns true if this object was deleted in Microsoft Word while change tracking was enabled.

isEndOfCell

public boolean isEndOfCell()
True if this paragraph is the last paragraph in a Aspose.Words.Tables.Cell; false otherwise.

isEndOfDocument

public boolean isEndOfDocument()
True if this paragraph is the last paragraph in the last section of the document.

isEndOfHeaderFooter

public boolean isEndOfHeaderFooter()
True if this paragraph is the last paragraph in the HeaderFooter (main text story) of a Section; false otherwise.

isEndOfSection

public boolean isEndOfSection()
True if this paragraph is the last paragraph in the Body (main text story) of a Section; false otherwise.

isFormatRevision

public boolean isFormatRevision()
Returns true if formatting of the object was changed in Microsoft Word while change tracking was enabled.

isInCell

public boolean isInCell()
True if this paragraph is an immediate child of Aspose.Words.Tables.Cell; false otherwise.

isInsertRevision

public boolean isInsertRevision()
Returns true if this object was inserted in Microsoft Word while change tracking was enabled.

isListItem

public boolean isListItem()
True when the paragraph is an item in a bulleted or numbered list in original revision.

getLastChild

→ inherited from CompositeNode
public Node getLastChild()
Gets the last child of the node. If there is no last child node, a null is returned.

getListFormat

public ListFormat getListFormat()
Provides access to the list formatting properties of the paragraph.

getListLabel

public Aspose.Words.Lists.ListLabel getListLabel()
Gets a ListLabel object that provides access to list numbering value and formatting for this paragraph.

getNextSibling

→ inherited from Node
public Node getNextSibling()
Gets the node immediately following this node. If there is no next node, a null is returned.

getNodeType

public int getNodeType()
Returns NodeType.Paragraph. The value of the property is NodeType integer constant.

getParagraphBreakFont

public Font getParagraphBreakFont()
Provides access to the font formatting of the paragraph break character.

getParagraphFormat

public ParagraphFormat getParagraphFormat()
Provides access to the paragraph formatting properties.

getParentNode

→ inherited from Node
public CompositeNode getParentNode()
Gets the immediate parent of this node.

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()
Retrieves the parent Section of the paragraph.

getParentStory

public Story getParentStory()
Retrieves the parent section-level story that can be Body or HeaderFooter.

getPreviousSibling

→ inherited from Node
public Node getPreviousSibling()
Gets the node immediately preceding this node. If there is no preceding node, a null is returned.

getRange

→ inherited from Node
public Range getRange()
Returns a Range object that represents the portion of a document that is contained in this node.

getRuns

public RunCollection getRuns()
Provides access to the typed collection of pieces of text inside the paragraph.

Method Detail

accept

public boolean accept(DocumentVisitor visitor)
              throws java.lang.Exception
Accepts a visitor.

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.

Calls DocumentVisitor.VisitParagraphStart, then calls Accept for all child nodes of the paragraph and calls DocumentVisitor.VisitParagraphEnd at the end.
Parameters:
visitor - The visitor that will visit the nodes.
Returns:
True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.

appendChild

→ inherited from CompositeNode
public Node appendChild(Node newChild)
Adds the specified node to the end of the list of child nodes for this 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 DocumentBase.importNode(com.aspose.words.Node,boolean,int) to import the node to the current document. The imported node can then be inserted into the current document.

Parameters:
newChild - The node to add.
Returns:
The node added.

appendField

public Aspose.Words.Fields.Field appendField(java.lang.String fieldCode)
                 throws java.lang.Exception
Appends a field to this paragraph.
Parameters:
fieldCode - The field code to append (without curly braces).
Returns:
A Aspose.Words.Fields.Field object that represents the appended field.

appendField

public Aspose.Words.Fields.Field appendField(java.lang.String fieldCode, java.lang.String fieldValue)
Appends a field to this paragraph.
Parameters:
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.
Returns:
A Aspose.Words.Fields.Field object that represents the appended field.

clearParaAttrs

public void clearParaAttrs()
Reserved for internal use.

clearRunAttrs

public void clearRunAttrs()
Reserved for internal use.

deepClone

→ inherited from Node
public Node deepClone(boolean isCloneChildren)
Creates a duplicate of the node.

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.

Parameters:
isCloneChildren - True to recursively clone the subtree under the specified node; false to clone only the node itself.
Returns:
The cloned node.

fetchInheritedParaAttr

public java.lang.Object fetchInheritedParaAttr(int key)
Reserved for internal use.

fetchInheritedRunAttr

public java.lang.Object fetchInheritedRunAttr(int key)
Reserved for internal use.

fetchParaAttr

public java.lang.Object fetchParaAttr(int key)
Reserved for internal use.

getAncestor

→ inherited from Node
public CompositeNode getAncestor(int ancestorType)
Gets the first ancestor of the specified NodeType.
Parameters:
ancestorType - A NodeType value. The node type of the ancestor to retrieve.
Returns:
The ancestor of the specified type or null if no ancestor of this type was found.

getAncestor

→ inherited from Node
public CompositeNode getAncestor(java.lang.Class ancestorType)
Gets the first ancestor of the specified object type.

The ancestor type matches if it is equal to ancestorType or derived from ancestorType.

Parameters:
ancestorType - The object type of the ancestor to retrieve.
Returns:
The ancestor of the specified type or null if no ancestor of this type was found.

getChild

→ inherited from CompositeNode
public Node getChild(int nodeType, int index, boolean isDeep)
Returns an Nth child node that matches the specified type.

If index is out of range, a null is returned.

Note that markup nodes (NodeType.STRUCTURED_DOCUMENT_TAG and NodeType.SMART_TAG) are traversed even when isDeep = false and GetChild is invoked for non-markup node type. For example if the first run in a para is wrapped in a StructuredDocumentTag, it will still be returned by GetChild(NodeType.Run, 0, false).
Parameters:
nodeType - A NodeType value. Specifies the type of the child node.
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.
Returns:
The child node that matches the criteria or null if no matching node is found.

getChildNodes

→ inherited from CompositeNode
public NodeCollection getChildNodes(int nodeType, boolean isDeep)
Returns a live collection of child nodes that match the specified type.

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.

Parameters:
nodeType - A NodeType value. Specifies the type of nodes to select.
isDeep - True to select from all child nodes recursively. False to select only among immediate children.
Returns:
A live collection of child nodes of the specified type.

getContainer

→ inherited from CompositeNode
public CompositeNode getContainer()
Reserved for internal use.

getDeleteRevision

public aspose.obfuscated.type getDeleteRevision()
Reserved for internal use.

getDirectParaAttr

public java.lang.Object getDirectParaAttr(int key)
Reserved for internal use.

getDirectParaAttrsCount

public int getDirectParaAttrsCount()
Reserved for internal use.

getDirectParaKey

public int getDirectParaKey(int index)
Reserved for internal use.

getDirectRunAttr

public java.lang.Object getDirectRunAttr(int key)
Reserved for internal use.

getDirectRunAttrsCount

public int getDirectRunAttrsCount()
Reserved for internal use.

getEffectiveTabStops

public Aspose.Words.TabStop[] getEffectiveTabStops()
Returns array of all tab stops applied to this paragraph, including applied indirectly by styles or lists.

getInsertRevision

public aspose.obfuscated.type getInsertRevision()
Reserved for internal use.

getMoveFromRevision

public aspose.obfuscated.type getMoveFromRevision()
Reserved for internal use.

getMoveToRevision

public aspose.obfuscated.type getMoveToRevision()
Reserved for internal use.

getNextMatchingNode

→ inherited from CompositeNode
public Node getNextMatchingNode(aspose.obfuscated.type curNode)
Reserved for internal use.

getText

public java.lang.String getText()
Gets the text of this paragraph including the end of paragraph character.

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 ControlChar.


indexOf

→ inherited from CompositeNode
public int indexOf(Node child)
Returns the index of the specified child node in the child node array. Returns -1 if the node is not found in the child nodes.

insertAfter

→ inherited from CompositeNode
public Node insertAfter(Node newChild, Node refChild)
Inserts the specified node immediately after the specified reference node.

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 DocumentBase.importNode(com.aspose.words.Node,boolean,int) to import the node to the current document. The imported node can then be inserted into the current document.

Parameters:
newChild - The Node to insert.
refChild - The Node that is the reference node. The newNode is placed after the refNode.
Returns:
The inserted node.

insertBefore

→ inherited from CompositeNode
public Node insertBefore(Node newChild, Node refChild)
Inserts the specified node immediately before the specified reference node.

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 DocumentBase.importNode(com.aspose.words.Node,boolean,int) to import the node to the current document. The imported node can then be inserted into the current document.

Parameters:
newChild - The Node to insert.
refChild - The Node that is the reference node. The newChild is placed before this node.
Returns:
The inserted node.

insertField

public Aspose.Words.Fields.Field insertField(java.lang.String fieldCode, Node refNode, boolean isAfter)
                 throws java.lang.Exception
Inserts a field into this paragraph.
Parameters:
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.
Returns:
A Aspose.Words.Fields.Field object that represents the inserted field.

insertField

public Aspose.Words.Fields.Field insertField(java.lang.String fieldCode, java.lang.String fieldValue, Node refNode, boolean isAfter)
Inserts a field into this paragraph.
Parameters:
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.
Returns:
A Aspose.Words.Fields.Field object that represents the inserted field.

iterator

→ inherited from CompositeNode
public java.util.Iterator iterator()
Provides support for the for each style iteration over the child nodes of this node.

joinRunsWithSameFormatting

public int joinRunsWithSameFormatting()
Joins runs with the same formatting in the paragraph.
Returns:
Number of joins performed. When N adjacent runs are being joined they count as N - 1 joins.

nextPreOrder

→ inherited from Node
public Node nextPreOrder(Node rootNode)
Gets next node according to the pre-order tree traversal algorithm.
Parameters:
rootNode - The top node (limit) of traversal.
Returns:
Next node in pre-order order. Null if reached the rootNode.

prependChild

→ inherited from CompositeNode
public Node prependChild(Node newChild)
Adds the specified node to the beginning of the list of child nodes for this 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 DocumentBase.importNode(com.aspose.words.Node,boolean,int) to import the node to the current document. The imported node can then be inserted into the current document.

Parameters:
newChild - The node to add.
Returns:
The node added.

previousPreOrder

→ inherited from Node
public Node previousPreOrder(Node rootNode)
Gets the previous node according to the pre-order tree traversal algorithm.
Parameters:
rootNode - The top node (limit) of traversal.
Returns:
Previous node in pre-order order. Null if reached the rootNode.

remove

→ inherited from Node
public void remove()
Removes itself from the parent.

removeAllChildren

→ inherited from CompositeNode
public void removeAllChildren()
Removes all the child nodes of the current node.

removeChild

→ inherited from CompositeNode
public Node removeChild(Node oldChild)
Removes the specified child node.

The parent of oldChild is set to null after the node is removed.

Parameters:
oldChild - The node to remove.
Returns:
The removed node.

removeParaAttr

public void removeParaAttr(int key)
Reserved for internal use.

removeRunAttr

public void removeRunAttr(int key)
Reserved for internal use.

removeSmartTags

→ inherited from CompositeNode
public void removeSmartTags()
Removes all Aspose.Words.Markup.SmartTag descendant nodes of the current node. This method does not remove the content of the smart tags.

selectNodes

→ inherited from CompositeNode
public NodeList selectNodes(java.lang.String xpath)
Selects a list of nodes matching the XPath expression.

Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.

Parameters:
xpath - The XPath expression.
Returns:
A list of nodes matching the XPath query.

selectSingleNode

→ inherited from CompositeNode
public Node selectSingleNode(java.lang.String xpath)
Selects the first Node that matches the XPath expression.

Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.

Parameters:
xpath - The XPath expression.
Returns:
The first Node that matches the XPath query or null if no matching node is found.

setDeleteRevision

public void setDeleteRevision(aspose.obfuscated.type value)
Reserved for internal use.

setInsertRevision

public void setInsertRevision(aspose.obfuscated.type value)
Reserved for internal use.

setMoveFromRevision

public void setMoveFromRevision(aspose.obfuscated.type value)
Reserved for internal use.

setMoveToRevision

public void setMoveToRevision(aspose.obfuscated.type value)
Reserved for internal use.

setParaAttr

public void setParaAttr(int key, java.lang.Object value)
Reserved for internal use.

setRunAttr

public void setRunAttr(int key, java.lang.Object value)
Reserved for internal use.

toString

→ inherited from Node
public java.lang.String toString(int saveFormat)
               throws java.lang.Exception
Exports the content of the node into a string in the specified format.
Returns:
The content of the node in the specified format.
Parameters:
saveFormat - A SaveFormat value.

toTxt

→ inherited from Node
public java.lang.String toTxt()
            throws java.lang.Exception
Exports the content of the node into a string in plain text format.

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 getText() which just gets the text from the node without removing field codes or special characters.

Returns:
The content of the node in plain text format.
See Also:
#Error Cref: P:Aspose.Words.Saving.TxtSaveOptions.ParagraphBreak, #Error Cref: P:Aspose.Words.Saving.TxtSaveOptions.ExportHeadersFooters

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.