com.aspose.words
Class Run

java.lang.Object
  extended by Node
      extended by Inline
          extended by com.aspose.words.Run
All Implemented Interfaces:
java.lang.Cloneable

public class Run 
extends Inline

Represents a run of characters with the same font formatting.

All text of the document is stored in runs of text.

Run can only be a child of Paragraph.


Constructor Summary
Run(DocumentBase doc)
           Initializes a new instance of the Run class.
Run(DocumentBase doc, java.lang.String text)
           Initializes a new instance of the Run class.
 
Property Getters/Setters Summary
DocumentBasegetDocument()→ inherited from Node
           Gets the document to which this node belongs.
FontgetFont()→ inherited from Inline
           Provides access to the font formatting of this object.
booleanisComposite()→ inherited from Node
           Returns true if this node can contain other nodes.
booleanisDeleteRevision()→ inherited from Inline
           Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
booleanisFormatRevision()→ inherited from Inline
           Returns true if formatting of the object was changed in Microsoft Word while change tracking was enabled.
booleanisInsertRevision()→ inherited from Inline
           Returns true if this object was inserted in Microsoft Word while change tracking was enabled.
NodegetNextSibling()→ inherited from Node
           Gets the node immediately following this node.
intgetNodeType()
           Returns NodeType.Run. The value of the property is NodeType integer constant.
CompositeNodegetParentNode()→ inherited from Node
           Gets the immediate parent of this node.
ParagraphgetParentParagraph()→ inherited from Inline
           Retrieves the parent Paragraph of this node.
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.
java.lang.StringgetText()
voidsetText(java.lang.String value)
           Gets or sets the text of the run.
 
Method Summary
booleanaccept(DocumentVisitor visitor)
           Accepts a visitor.
voidclearRunAttrs()→ inherited from Inline
          Reserved for internal use.
NodedeepClone(boolean isCloneChildren)→ inherited from Node
           Creates a duplicate of the node.
java.lang.ObjectfetchInheritedRunAttr(int fontAttr)→ inherited from Inline
          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.
aspose.obfuscated.typegetDeleteRevision()→ inherited from Inline
          Reserved for internal use.
java.lang.ObjectgetDirectRunAttr(int fontAttr)→ inherited from Inline
          Reserved for internal use.
intgetDirectRunAttrsCount()→ inherited from Inline
          Reserved for internal use.
DocumentBasegetDocument_IInline()→ inherited from Inline
          Reserved for internal use.
aspose.obfuscated.typegetExpandedRunPr_IInline(aspose.obfuscated.type flags)→ inherited from Inline
          Reserved for internal use.
aspose.obfuscated.typegetInsertRevision()→ inherited from Inline
          Reserved for internal use.
aspose.obfuscated.typegetMoveFromRevision()→ inherited from Inline
          Reserved for internal use.
aspose.obfuscated.typegetMoveToRevision()→ inherited from Inline
          Reserved for internal use.
ParagraphgetParentParagraph_IInline()→ inherited from Inline
          Reserved for internal use.
aspose.obfuscated.typegetRunPr_IInline()→ inherited from Inline
          Reserved for internal use.
java.lang.StringgetText()
           Gets the text of the run.
NodenextPreOrder(Node rootNode)→ inherited from Node
           Gets next node according to the pre-order tree traversal algorithm.
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.
voidremoveRunAttr(int key)→ inherited from Inline
          Reserved for internal use.
voidsetDeleteRevision(aspose.obfuscated.type value)→ inherited from Inline
          Reserved for internal use.
voidsetInsertRevision(aspose.obfuscated.type value)→ inherited from Inline
          Reserved for internal use.
voidsetMoveFromRevision(aspose.obfuscated.type value)→ inherited from Inline
          Reserved for internal use.
voidsetMoveToRevision(aspose.obfuscated.type value)→ inherited from Inline
          Reserved for internal use.
voidsetRunAttr(int fontAttr, java.lang.Object value)→ inherited from Inline
          Reserved for internal use.
voidsetRunPr_IInline(aspose.obfuscated.type value)→ inherited from Inline
          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

Run

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

When Run is created, it belongs to the specified document, but is not yet part of the document and ParentNode is null.

To append Run to the document use InsertAfter or InsertBefore on the paragraph where you want the run inserted.

Parameters:
doc - The owner document.

Run

public Run(DocumentBase doc, java.lang.String text)
Initializes a new instance of the Run class.

When Run is created, it belongs to the specified document, but is not yet part of the document and ParentNode is null.

To append Run to the document use InsertAfter or InsertBefore on the paragraph where you want the run inserted.

Parameters:
doc - The owner document.
text - The text of the run.

Property Getters/Setters Detail

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.


getFont

→ inherited from Inline
public Font getFont()
Provides access to the font formatting of this object.

isComposite

→ inherited from Node
public boolean isComposite()
Returns true if this node can contain other nodes. This method returns false as Node cannot have child nodes.

isDeleteRevision

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

isFormatRevision

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

isInsertRevision

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

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.Run. The value of the property is NodeType integer constant.

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.


getParentParagraph

→ inherited from Inline
public Paragraph getParentParagraph()
Retrieves the parent Paragraph of this node.

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.

getText/setText

public java.lang.String getText() / public void setText(java.lang.String value)
Gets or sets the text of the run.

Method Detail

accept

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

Calls DocumentVisitor.VisitRun.

For more info see the Visitor design pattern.

Parameters:
visitor - The visitor that will visit the node.
Returns:
False if the visitor requested the enumeration to stop.

clearRunAttrs

→ inherited from Inline
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.

fetchInheritedRunAttr

→ inherited from Inline
public java.lang.Object fetchInheritedRunAttr(int fontAttr)
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.

getDeleteRevision

→ inherited from Inline
public aspose.obfuscated.type getDeleteRevision()
Reserved for internal use.

getDirectRunAttr

→ inherited from Inline
public java.lang.Object getDirectRunAttr(int fontAttr)
Reserved for internal use.

getDirectRunAttrsCount

→ inherited from Inline
public int getDirectRunAttrsCount()
Reserved for internal use.

getDocument_IInline

→ inherited from Inline
public DocumentBase getDocument_IInline()
Reserved for internal use.

getExpandedRunPr_IInline

→ inherited from Inline
public aspose.obfuscated.type getExpandedRunPr_IInline(aspose.obfuscated.type flags)
Reserved for internal use.

getInsertRevision

→ inherited from Inline
public aspose.obfuscated.type getInsertRevision()
Reserved for internal use.

getMoveFromRevision

→ inherited from Inline
public aspose.obfuscated.type getMoveFromRevision()
Reserved for internal use.

getMoveToRevision

→ inherited from Inline
public aspose.obfuscated.type getMoveToRevision()
Reserved for internal use.

getParentParagraph_IInline

→ inherited from Inline
public Paragraph getParentParagraph_IInline()
Reserved for internal use.

getRunPr_IInline

→ inherited from Inline
public aspose.obfuscated.type getRunPr_IInline()
Reserved for internal use.

getText

public java.lang.String getText()
Gets the text of the run.
Returns:
The text of the run.

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.

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.

removeRunAttr

→ inherited from Inline
public void removeRunAttr(int key)
Reserved for internal use.

setDeleteRevision

→ inherited from Inline
public void setDeleteRevision(aspose.obfuscated.type value)
Reserved for internal use.

setInsertRevision

→ inherited from Inline
public void setInsertRevision(aspose.obfuscated.type value)
Reserved for internal use.

setMoveFromRevision

→ inherited from Inline
public void setMoveFromRevision(aspose.obfuscated.type value)
Reserved for internal use.

setMoveToRevision

→ inherited from Inline
public void setMoveToRevision(aspose.obfuscated.type value)
Reserved for internal use.

setRunAttr

→ inherited from Inline
public void setRunAttr(int fontAttr, java.lang.Object value)
Reserved for internal use.

setRunPr_IInline

→ inherited from Inline
public void setRunPr_IInline(aspose.obfuscated.type 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.