java.lang.ObjectNode
com.aspose.words.EditableRangeStart
public class EditableRangeStart
A complete editable range in a Word document consists of a Use the Note: Currently editable ranges are supported only at the inline-level, that is inside
Property Getters/Setters Summary | ||
---|---|---|
DocumentBase | getDocument() | → inherited from Node |
Gets the document to which this node belongs. | ||
EditableRange | getEditableRange() | |
Gets the facade object that encapsulates this editable range start and end. | ||
int | getId() | |
void | setId(int value) | |
Specifies the identifier of the editable range. | ||
boolean | isComposite() | → inherited from Node |
Returns true if this node can contain other nodes. | ||
Node | getNextSibling() | → inherited from Node |
Gets the node immediately following this node. | ||
int | getNodeType() | |
Returns |
||
CompositeNode | getParentNode() | → inherited from Node |
Gets the immediate parent of this node. | ||
Node | getPreviousSibling() | → inherited from Node |
Gets the node immediately preceding this node. | ||
Range | getRange() | → inherited from Node |
Returns a Range object that represents the portion of a document that is contained in this node. |
Method Summary | ||
---|---|---|
boolean | accept(DocumentVisitor visitor) | |
Accepts a visitor. | ||
Node | deepClone(boolean isCloneChildren) | → inherited from Node |
Creates a duplicate of the node. | ||
CompositeNode | getAncestor(int ancestorType) | → inherited from Node |
Gets the first ancestor of the specified |
||
CompositeNode | getAncestor(java.lang.Class ancestorType) | → inherited from Node |
Gets the first ancestor of the specified object type. | ||
int | getId_INodeWithAnnotationId() | |
Reserved for internal use. | ||
java.lang.String | getText() | → inherited from Node |
Gets the text of this node and of all its children. | ||
Node | nextPreOrder(Node rootNode) | → inherited from Node |
Gets next node according to the pre-order tree traversal algorithm. | ||
Node | previousPreOrder(Node rootNode) | → inherited from Node |
Gets the previous node according to the pre-order tree traversal algorithm. | ||
void | remove() | → inherited from Node |
Removes itself from the parent. | ||
void | setId_INodeWithAnnotationId(int value) | |
Reserved for internal use. | ||
java.lang.String | toString(int saveFormat) | → inherited from Node |
Exports the content of the node into a string in the specified format. | ||
java.lang.String | toTxt() | → inherited from Node |
Exports the content of the node into a string in plain text format. |
Property Getters/Setters Detail |
---|
getDocument | → inherited from Node |
public DocumentBase getDocument() |
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.
getEditableRange | |
public EditableRange getEditableRange() |
getId/setId | |
public int getId() / public void setId(int value) |
isComposite | → inherited from Node |
public boolean isComposite() |
getNextSibling | → inherited from Node |
public Node getNextSibling() |
getNodeType | |
public int getNodeType() |
getParentNode | → inherited from Node |
public CompositeNode getParentNode() |
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() |
getRange | → inherited from Node |
public Range getRange() |
Method Detail |
---|
accept | |
public boolean accept(DocumentVisitor visitor) throws java.lang.Exception |
Calls
For more info see the Visitor design pattern.
visitor
- The visitor that will visit the node.deepClone | → inherited from Node |
public Node deepClone(boolean isCloneChildren) |
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.
isCloneChildren
- True to recursively clone the subtree under the specified node;
false to clone only the node itself.getAncestor | → inherited from Node |
public CompositeNode getAncestor(int ancestorType) |
ancestorType
- A getAncestor | → inherited from Node |
public CompositeNode getAncestor(java.lang.Class ancestorType) |
The ancestor type matches if it is equal to ancestorType or derived from ancestorType.
ancestorType
- The object type of the ancestor to retrieve.getId_INodeWithAnnotationId | |
public int getId_INodeWithAnnotationId() |
getText | → inherited from Node |
public java.lang.String getText() |
The returned string includes all control and special characters as described in
nextPreOrder | → inherited from Node |
public Node nextPreOrder(Node rootNode) |
rootNode
- The top node (limit) of traversal.previousPreOrder | → inherited from Node |
public Node previousPreOrder(Node rootNode) |
rootNode
- The top node (limit) of traversal.remove | → inherited from Node |
public void remove() |
setId_INodeWithAnnotationId | |
public void setId_INodeWithAnnotationId(int value) |
toString | → inherited from Node |
public java.lang.String toString(int saveFormat) throws java.lang.Exception |
saveFormat
- A SaveFormat value.toTxt | → inherited from Node |
public java.lang.String toTxt() throws java.lang.Exception |
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