FieldSeparator
Overview
FieldSeparator is a class in Aspose.Words FOSS for Java.
Inherits from: FieldChar.
Represents a Word field separator that separates the field code from the field result.
Edition status of its 49 listed members (a property and its accessor methods are listed separately, overloads once): 49 not yet exercised by a verified example.
This class declares 34 methods for FieldSeparator objects in Java programs.
Available methods include: accept, deepClone, getAncestor, getCustomNodeId, getDocument, getField, getFieldType, getFont, getNextSibling, getNodeType, getParentNode, getParentParagraph, 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, dirty, document, field, and 14 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
nodeType | int | Read | Returns FieldSeparator. |
field | Field | Read | Returns a field for the field char. |
fieldType | int | Read | Returns the type of the field. |
locked | boolean | Read/Write | Gets or sets whether the parent field is locked (should not recalculate its result). |
dirty | boolean | Read/Write | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
text | String | Read | Gets the special character that this node represents. |
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 |
|---|---|
getNodeType() → int | Returns FieldSeparator. |
accept(visitor: DocumentVisitor) → boolean | Accepts a visitor. |
getField() → Field | Returns a field for the field char. |
getFieldType() → int | Returns the type of the field. |
isLocked() → boolean | Gets or sets whether the parent field is locked (should not recalculate its result). |
isLocked(value: boolean) | Calls isLocked(value) on this FieldSeparator instance. |
isDirty() → boolean | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
isDirty(value: boolean) | Calls isDirty(value) on this FieldSeparator instance. |
getText() → String | Gets the special character that this node represents. |
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 FieldSeparator 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 FieldSeparator instance. |