java.lang.Object
Node
com.aspose.words.EditableRangeEnd
- All Implemented Interfaces:
- java.lang.Cloneable
public class EditableRangeEnd
- extends Node
Represents an end of an editable range in a Word document.
A complete editable range in a Word document consists of a EditableRangeStart
and a matching EditableRangeEnd with the same Id.
EditableRangeStart and EditableRangeEnd are just markers inside a document
that specify where the editable range starts and ends.
Use the EditableRange class as a "facade" to work with an editable range
as a single object.
Note: Currently editable ranges are supported only at the inline-level, that is inside Paragraph,
but editable range start and editable range end can be in different paragraphs.
Property Getters/Setters Detail |
-
Gets the document to which this node belongs.
The node always belongs to a document even if it has just been created
and not yet added to the tree, or if it has been removed from the tree.
-
Corresponding EditableRangeStart, received by ID.
getId/setId | |
public int getId() / public void setId(int value)
|
-
Specifies the identifier of the editable range.
isComposite | → inherited from Node |
public boolean isComposite()
|
-
Returns true if this node can contain other nodes.
This method returns false as Node cannot have child nodes.
getNextSibling | → inherited from Node |
public Node getNextSibling()
|
-
Gets the node immediately following this node.
If there is no next node, a null is returned.
getNodeType | |
public int getNodeType()
|
-
Returns NodeType.EDITABLE_RANGE_END.
The value of the property is NodeType integer constant.
-
Gets the immediate parent of this node.
If a node has just been created and not yet added to the tree,
or if it has been removed from the tree, the parent is null.
getPreviousSibling | → inherited from Node |
public Node getPreviousSibling()
|
-
Gets the node immediately preceding this node.
If there is no preceding node, a null is returned.
getRange | → inherited from Node |
public Range getRange()
|
-
Returns a Range object that represents the portion of a document that is contained in this node.
accept | |
public boolean accept(DocumentVisitor visitor)
throws java.lang.Exception |
-
Accepts a visitor.
Calls DocumentVisitor.visitEditableRangeEnd(com.aspose.words.EditableRangeEnd).
For more info see the Visitor design pattern.
- Parameters:
visitor
- The visitor that will visit the node.
- Returns:
- False if the visitor requested the enumeration to stop.
deepClone | → inherited from Node |
public Node deepClone(boolean isCloneChildren) |
-
Creates a duplicate of the node.
This method serves as a copy constructor for nodes.
The cloned node has no parent, but belongs to the same document as the original node.
This method always performs a deep copy of the node. The isCloneChildren parameter
specifies whether to perform copy all child nodes as well.
- Parameters:
isCloneChildren
- True to recursively clone the subtree under the specified node;
false to clone only the node itself.
- Returns:
- The cloned node.
-
Gets the first ancestor of the specified NodeType.
- Parameters:
ancestorType
- A NodeType value. The node type of the ancestor to retrieve.
- Returns:
- The ancestor of the specified type or null if no ancestor of this type was found.
getAncestor | → inherited from Node |
public CompositeNode getAncestor(java.lang.Class ancestorType) |
-
Gets the first ancestor of the specified object type.
The ancestor type matches if it is equal to ancestorType or derived from ancestorType.
- Parameters:
ancestorType
- The object type of the ancestor to retrieve.
- Returns:
- The ancestor of the specified type or null if no ancestor of this type was found.
getId_INodeWithAnnotationId | |
public int getId_INodeWithAnnotationId() |
- Reserved for internal use.
getText | → inherited from Node |
public java.lang.String getText() |
-
Gets the text of this node and of all its children.
The returned string includes all control and special characters as described in ControlChar.
nextPreOrder | → inherited from Node |
public Node nextPreOrder(Node rootNode) |
-
Gets next node according to the pre-order tree traversal algorithm.
- Parameters:
rootNode
- The top node (limit) of traversal.
- Returns:
- Next node in pre-order order. Null if reached the rootNode.
previousPreOrder | → inherited from Node |
public Node previousPreOrder(Node rootNode) |
-
Gets the previous node according to the pre-order tree traversal algorithm.
- Parameters:
rootNode
- The top node (limit) of traversal.
- Returns:
- Previous node in pre-order order. Null if reached the rootNode.
remove | → inherited from Node |
public void remove() |
-
Removes itself from the parent.
setId_INodeWithAnnotationId | |
public void setId_INodeWithAnnotationId(int value) |
- Reserved for internal use.
toString | → inherited from Node |
public java.lang.String toString(int saveFormat)
throws java.lang.Exception |
-
Exports the content of the node into a string in the specified format.
- Returns:
- The content of the node in the specified format.
- Parameters:
saveFormat
- A SaveFormat value.
toTxt | → inherited from Node |
public java.lang.String toTxt()
throws java.lang.Exception |
-
Exports the content of the node into a string in plain text format.
This method removes field codes and Microsoft Word control characters, uses CrLf
(or any other) combination of characters to mark ends of paragraphs in the resulting string.
It produces a different result from getText() which just gets the text from
the node without removing field codes or special characters.
- Returns:
- The content of the node in plain text format.
- See Also:
- #Error Cref: P:Aspose.Words.Saving.TxtSaveOptions.ParagraphBreak, #Error Cref: P:Aspose.Words.Saving.TxtSaveOptions.ExportHeadersFooters
See Also:
Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
Aspose.Words Support Forum - our preferred method of support.