EditableRangeStart

EditableRangeStart

Overview

EditableRangeStart is a class in Aspose.Words FOSS for Java. Inherits from: Node, IDisplaceableByCustomXml, INodeWithAnnotationId.

Represents a start of an editable range in a Word document.

Edition status of its 32 listed members (a property and its accessor methods are listed separately, overloads once): 32 not yet exercised by a verified example.

This class declares 24 methods for EditableRangeStart objects in Java programs. Available methods include: accept, deepClone, getAncestor, getCustomNodeId, getDocument, getEditableRange, getId, getNextSibling, getNodeType, getParentNode, getPreviousSibling, getRange, and 9 additional methods. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: composite, customNodeId, document, editableRange, id, nextSibling, and 5 more.

Properties

NameTypeAccessDescription
idintRead/WriteSpecifies the identifier of the editable range.
editableRangeEditableRangeReadGets the facade object that encapsulates this editable range start and end.
nodeTypeintReadReturns EditableRangeStart.
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.
textStringReadGets the text of this node and of all its children.
customNodeIdintRead/WriteSpecifies custom node identifier.

Methods

SignatureDescription
accept(visitor: DocumentVisitor) → booleanAccepts a visitor.
getId() → intSpecifies the identifier of the editable range.
setId(value: int)Sets the id value.
getEditableRange() → EditableRangeGets the facade object that encapsulates this editable range start and end.
getNodeType() → intReturns EditableRangeStart.
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 EditableRangeStart instance.
getText() → StringGets the text of this node and of all its children.
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 EditableRangeStart instance.

See Also