FieldChar

Overview

FieldChar is a class in Aspose.Words FOSS for Java. Inherits from: SpecialChar.

Base class for nodes that represent field characters in a document.

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 FieldChar 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

NameTypeAccessDescription
fieldFieldReadReturns a field for the field char.
fieldTypeintReadReturns the type of the field.
lockedbooleanRead/WriteGets or sets whether the parent field is locked (should not recalculate its result).
dirtybooleanRead/WriteGets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
nodeTypeintReadReturns SpecialChar.
textStringReadGets the special character that this node represents.
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
getField() → FieldReturns a field for the field char.
getFieldType() → intReturns the type of the field.
isLocked() → booleanGets or sets whether the parent field is locked (should not recalculate its result).
isLocked(value: boolean)Calls isLocked(value) on this FieldChar instance.
isDirty() → booleanGets 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 FieldChar instance.
getNodeType() → intReturns SpecialChar.
accept(visitor: DocumentVisitor) → booleanAccepts a visitor.
getText() → StringGets the special character that this node represents.
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 FieldChar 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 FieldChar instance.

See Also