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

NameTypeAccessDescription
nodeTypeintReadReturns Run.
textStringRead/WriteGets or sets the text.
phoneticGuidePhoneticGuideReadGets a PhoneticGuide object.
parentParagraphParagraphReadRetrieves the parent Paragraph of this node.
fontFontReadProvides access to the font formatting of this object.
insertRevisionbooleanReadGets the insert revision.
deleteRevisionbooleanReadGets the delete revision.
moveFromRevisionbooleanReadGets the move from revision.
moveToRevisionbooleanReadGets the move to revision.
formatRevisionbooleanReadGets the format revision.
parentNodeCompositeNodeReadGets the immediate parent of this node.
documentDocumentBaseReadGets the document to which this node belongs.
previousSiblingNodeReadGets the node immediately preceding this node.
nextSiblingNodeReadGets the node immediately following this node.
compositebooleanReadReturns true if this node can contain other nodes.
rangeRangeReadReturns a Range object that represents the portion of a document that is contained in this node.
customNodeIdintRead/WriteSpecifies custom node identifier.

Methods

SignatureDescription
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() → intReturns Run.
getText() → StringReturns the text.
setText(value: String)Sets the text value.
isPhoneticGuide() → booleanGets a boolean value indicating either the run is a phonetic guide.
getPhoneticGuide() → PhoneticGuideGets a PhoneticGuide object.
accept(visitor: DocumentVisitor) → booleanAccepts a visitor.
getParentParagraph() → ParagraphRetrieves the parent Paragraph of this node.
getFont() → FontProvides access to the font formatting of this object.
isInsertRevision() → booleanReturns true if insert revision is set.
isDeleteRevision() → booleanReturns true if delete revision is set.
isMoveFromRevision() → booleanReturns true if move from revision is set.
isMoveToRevision() → booleanReturns true if move to revision is set.
isFormatRevision() → booleanReturns true if format revision is set.
getParentNode() → CompositeNodeGets the immediate parent of this node.
getDocument() → DocumentBaseGets the document to which this node belongs.
getPreviousSibling() → NodeGets the node immediately preceding this node.
getNextSibling() → NodeGets the node immediately following this node.
isComposite() → booleanReturns true if this node can contain other nodes.
getRange() → RangeReturns a Range object that represents the portion of a document that is contained in this node.
deepClone(isCloneChildren: boolean) → NodeCalls deepClone(isCloneChildren) on this Run instance.
getAncestor(ancestorType: Class) → CompositeNodeGets the first ancestor of the specified object type.
getAncestor(ancestorType: int) → CompositeNodeGets the first ancestor of the specified NodeType.
remove()Removes itself from the parent.
nextPreOrder(rootNode: Node) → NodeGets next node according to the pre-order tree traversal algorithm.
previousPreOrder(rootNode: Node) → NodeGets the previous node according to the pre-order tree traversal algorithm.
toString(saveFormat: int) → StringExports the content of the node into a string in the specified format.
toString(saveOptions: SaveOptions) → StringExports the content of the node into a string using the specified save options.
nodeTypeToString(nodeType: int) → StringA utility method that converts a node type enum value into a user friendly string.
getCustomNodeId() → intSpecifies custom node identifier.
setCustomNodeId(value: int)Sets the custom node id value.
toString() → StringCalls toString on this Run instance.

See Also