BookmarkStart class
BookmarkStart class
Represents a start of a bookmark in a Word document. To learn more, visit the Working with Bookmarks documentation article.
Remarks
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 BookmarkStart.bookmark class as a “facade” to work with a bookmark as a single object.
Inheritance: BookmarkStart → Node
Constructors
| Name | Description |
|---|---|
| BookmarkStart(doc, name) | Initializes a new instance of the BookmarkStart class. |
Properties
| Name | Description |
|---|---|
| bookmark | Gets the facade object that encapsulates this bookmark start and end. |
| custom_node_id | Specifies custom node identifier. (Inherited from Node) |
| document | Gets the document to which this node belongs. (Inherited from Node) |
| is_composite | Returns True if this node can contain other nodes.(Inherited from Node) |
| name | Gets or sets the bookmark name. |
| next_sibling | Gets the node immediately following this node. (Inherited from Node) |
| node_type | Returns NodeType.BOOKMARK_START. |
| parent_node | Gets the immediate parent of this node. (Inherited from Node) |
| previous_sibling | Gets the node immediately preceding this node. (Inherited from Node) |
| range | Returns a Range object that represents the portion of a document that is contained in this node. (Inherited from Node) |
Methods
| Name | Description |
|---|---|
| accept(visitor) | Accepts a visitor. |
| clone(is_clone_children) | Creates a duplicate of the node. (Inherited from Node) |
| get_ancestor(ancestor_type) | Gets the first ancestor of the specified object type. (Inherited from Node) |
| get_ancestor(ancestor_type) | Gets the first ancestor of the specified NodeType. (Inherited from Node) |
| get_text() | Returns an empty string. |
| next_pre_order(root_node) | Gets next node according to the pre-order tree traversal algorithm. (Inherited from Node) |
| node_type_to_string(node_type) | A utility method that converts a node type enum value into a user friendly string. (Inherited from Node) |
| previous_pre_order(root_node) | Gets the previous node according to the pre-order tree traversal algorithm. (Inherited from Node) |
| remove() | Removes itself from the parent. (Inherited from Node) |
| to_string(save_format) | Exports the content of the node into a string in the specified format. (Inherited from Node) |
| to_string(save_options) | Exports the content of the node into a string using the specified save options. (Inherited from Node) |
See Also
- module aspose.words
- class Node