Run
Overview
Run is a class in Aspose.Words FOSS for Java.
Inherits from: Inline.
Represents a run of characters with the same font formatting.
Edition status of its 46 listed members (a property and its accessor methods are listed separately, overloads once): 46 not yet exercised by a verified example.
This class declares 33 methods for Run objects in Java programs.
Available methods include: Run, accept, deepClone, getAncestor, getCustomNodeId, getDocument, getFont, getNextSibling, getNodeType, getParentNode, getParentParagraph, getPhoneticGuide, and 17 additional methods.
Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package.
Properties: composite, customNodeId, deleteRevision, document, font, formatRevision, and 11 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
nodeType | int | Read | Returns Run. |
text | String | Read/Write | Gets or sets the text. |
phoneticGuide | PhoneticGuide | Read | Gets a PhoneticGuide object. |
parentParagraph | Paragraph | Read | Retrieves the parent Paragraph of this node. |
font | Font | Read | Provides access to the font formatting of this object. |
insertRevision | boolean | Read | Gets the insert revision. |
deleteRevision | boolean | Read | Gets the delete revision. |
moveFromRevision | boolean | Read | Gets the move from revision. |
moveToRevision | boolean | Read | Gets the move to revision. |
formatRevision | boolean | Read | Gets the format revision. |
parentNode | CompositeNode | Read | Gets the immediate parent of this node. |
document | DocumentBase | Read | Gets the document to which this node belongs. |
previousSibling | Node | Read | Gets the node immediately preceding this node. |
nextSibling | Node | Read | Gets the node immediately following this node. |
composite | boolean | Read | Returns true if this node can contain other nodes. |
range | Range | Read | Returns a Range object that represents the portion of a document that is contained in this node. |
customNodeId | int | Read/Write | Specifies custom node identifier. |
Methods
| Signature | Description |
|---|---|
Run(doc: DocumentBase) | Initializes a new instance of the Run class. |
Run(doc: DocumentBase, text: String) | Initializes a new instance of the Run class. |
getNodeType() → int | Returns Run. |
getText() → String | Returns the text. |
setText(value: String) | Sets the text value. |
isPhoneticGuide() → boolean | Gets a boolean value indicating either the run is a phonetic guide. |
getPhoneticGuide() → PhoneticGuide | Gets a PhoneticGuide object. |
accept(visitor: DocumentVisitor) → boolean | Accepts a visitor. |
getParentParagraph() → Paragraph | Retrieves the parent Paragraph of this node. |
getFont() → Font | Provides access to the font formatting of this object. |
isInsertRevision() → boolean | Returns true if insert revision is set. |
isDeleteRevision() → boolean | Returns true if delete revision is set. |
isMoveFromRevision() → boolean | Returns true if move from revision is set. |
isMoveToRevision() → boolean | Returns true if move to revision is set. |
isFormatRevision() → boolean | Returns true if format revision is set. |
getParentNode() → CompositeNode | Gets the immediate parent of this node. |
getDocument() → DocumentBase | Gets the document to which this node belongs. |
getPreviousSibling() → Node | Gets the node immediately preceding this node. |
getNextSibling() → Node | Gets the node immediately following this node. |
isComposite() → boolean | Returns true if this node can contain other nodes. |
getRange() → Range | Returns a Range object that represents the portion of a document that is contained in this node. |
deepClone(isCloneChildren: boolean) → Node | Calls deepClone(isCloneChildren) on this Run instance. |
getAncestor(ancestorType: Class) → CompositeNode | Gets the first ancestor of the specified object type. |
getAncestor(ancestorType: int) → CompositeNode | Gets the first ancestor of the specified NodeType. |
remove() | Removes itself from the parent. |
nextPreOrder(rootNode: Node) → Node | Gets next node according to the pre-order tree traversal algorithm. |
previousPreOrder(rootNode: Node) → Node | Gets the previous node according to the pre-order tree traversal algorithm. |
toString(saveFormat: int) → String | Exports the content of the node into a string in the specified format. |
toString(saveOptions: SaveOptions) → String | Exports the content of the node into a string using the specified save options. |
nodeTypeToString(nodeType: int) → String | A utility method that converts a node type enum value into a user friendly string. |
getCustomNodeId() → int | Specifies custom node identifier. |
setCustomNodeId(value: int) | Sets the custom node id value. |
toString() → String | Calls toString on this Run instance. |