java.lang.Object
Node
com.aspose.words.BookmarkStart
- All Implemented Interfaces:
- java.lang.Cloneable
public class BookmarkStart
- extends Node
Represents a start 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 supported only at the inline-level, that is inside Paragraph,
but bookmark start and bookmark end can be in different paragraphs.
Constructor Summary |
BookmarkStart(DocumentBase doc, java.lang.String name)
Initializes a new instance of the BookmarkStart class.
|
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 NodeType.
|
CompositeNode | getAncestor(java.lang.Class ancestorType) | → inherited from Node |
Gets the first ancestor of the specified object type.
|
java.lang.String | getText() | |
Returns an empty string.
|
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 | 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.
|
BookmarkStart
public BookmarkStart(DocumentBase doc, java.lang.String name)
-
Initializes a new instance of the BookmarkStart class.
- Parameters:
doc
- The owner document.name
- The name of the bookmark. Cannot be null.
Property Getters/Setters Detail |
getBookmark | |
public Bookmark getBookmark()
|
-
Gets the facade object that encapsulates this bookmark start and end.
-
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.
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.
getName | |
public java.lang.String getName()
|
-
Get the bookmark name.
Cannot be null.
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.BOOKMARK_START.
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.visitBookmarkStart(com.aspose.words.BookmarkStart).
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.
getText | |
public java.lang.String getText() |
-
Returns an empty string.
- Returns:
- An empty string.
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.
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.