com.aspose.words
Class BookmarkEnd
java.lang.Object
Node
com.aspose.words.BookmarkEnd
- All Implemented Interfaces:
- java.lang.Iterable, java.lang.Cloneable
public class BookmarkEnd
- extends Node
Represents an end of a bookmark in a Word document.
A complete bookmark in a Word document consists of a BookmarkStart
and a matching BookmarkEnd with the same bookmark name.
BookmarkStart and BookmarkEnd are just markers inside a document
that specify where the bookmark starts and ends.
Use the Bookmark class as a "facade" to work with a bookmark
as a single object.
Note: Currently bookmarks are only supported in Body (main text story)
of the document.
Note: Currently bookmarks are supported only at the inline-level, that is
inside Paragraph. However BookmarkStart and BookmarkEnd
can be in different paragraphs.
Constructor Summary |
BookmarkEnd(Document doc, java.lang.String name)
Initializes a new instance of the BookmarkEnd class.
|
Method Summary |
boolean | accept(DocumentVisitor visitor) | |
Accepts a visitor.
|
Node | deepClone(boolean isCloneChildren) | → inherited from Node |
Creates a duplicate of the node.
|
Node | getAncestor(java.lang.Class ancestorType) | → inherited from Node |
Gets the first ancestor of the specified type.
|
java.lang.String | getText() | → inherited from Node |
Gets the text of this node and of all its children.
|
java.util.Iterator | iterator() | → inherited from Node |
Provides support for the for each style iteration over child nodes of the node. |
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.
|
java.lang.String | toTxt() | → inherited from Node |
Exports the content of the node into a string in TXT (plain text) format.
|
BookmarkEnd
public BookmarkEnd(Document doc, java.lang.String name)
-
Initializes a new instance of the BookmarkEnd class.
- Parameters:
doc
- The owner document.name
- The name of the bookmark.
Property Getters/Setters Detail |
getNodeType | |
public int getNodeType()
|
-
Returns NodeType.BookmarkEnd.
The value of the property is NodeType integer constant.
getName | |
public java.lang.String getName()
|
-
Gets the name of the bookmark.
-
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.
getDocument | → inherited from Node |
public Document getDocument()
|
-
Gets the document to which this node belongs.
The node always belongs to a document even if it has just been created
and not yed added to the tree, or if it has been removed from the tree.
getPreviousSibling | → inherited from Node |
public Node getPreviousSibling()
|
-
Gets the node immediately preceding this node.
If there is no preceding node, a null is returned.
Note: Calculating the value of this property iterates from the first child node of ParenNode
to this node.
getNextSibling | → inherited from Node |
public Node getNextSibling()
|
-
Gets the node immediately following this node.
If there is no next node, a null is returned.
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.
getRange | → inherited from Node |
public Range getRange()
|
-
Returns a Range object that represents the portion of a document that is contained in this node.
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.
accept | |
public boolean accept(DocumentVisitor visitor)
throws java.lang.Exception |
-
Accepts a visitor.
Calls DocumentVisitor.VisitBookmarkEnd.
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)
throws java.lang.Exception |
-
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.
getAncestor | → inherited from Node |
public Node getAncestor(java.lang.Class ancestorType) |
-
Gets the first ancestor of the specified type.
The ancestor type matches if it is equal to ancestorType or derived from ancestorType.
- Parameters:
ancestorType
- The type of the ancestor to retrieve.
- Returns:
- The ancestor of the specified type or null if no ancestor of this type was found.
remove | → inherited from Node |
public void remove()
throws java.lang.Exception |
-
Removes itself from the parent.
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.
toTxt | → inherited from Node |
public java.lang.String toTxt()
throws java.lang.Exception |
-
Exports the content of the node into a string in TXT (plain text) format.
This method removes field codes and Microsoft Word control characters, uses CrLf combination
to mark ends of paragraphs in the resulting string. It produces a different result from
getText() which just gets the text from the document without removing field
codes or special characters.
- Returns:
- The content of the node in plain text format.
iterator | → inherited from Node |
public java.util.Iterator iterator() |
- Provides support for the for each style iteration over child nodes of the node.
Non-CompositeNodes (like Run, SpecialChar and so on) return Empty non-null
iterator used internally for XPath traversal.
See Also:
Wiki - the home page for the Aspose.Words Product Documentation that includes Programmer's Guide, Knowledge Base and other articles.
Aspose.Words Support Forum - our preferred method of support.
Aspose.Words Team - contact Aspose.Words Team.