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: BookmarkStartNode

Constructors

NameDescription
BookmarkStart(doc, name)Initializes a new instance of the BookmarkStart class.

Properties

NameDescription
bookmarkGets the facade object that encapsulates this bookmark start and end.
custom_node_idSpecifies custom node identifier.
(Inherited from Node)
documentGets the document to which this node belongs.
(Inherited from Node)
is_compositeReturns True if this node can contain other nodes.
(Inherited from Node)
nameGets or sets the bookmark name.
next_siblingGets the node immediately following this node.
(Inherited from Node)
node_typeReturns NodeType.BOOKMARK_START.
parent_nodeGets the immediate parent of this node.
(Inherited from Node)
previous_siblingGets the node immediately preceding this node.
(Inherited from Node)
rangeReturns a Range object that represents the portion of a document that is contained in this node.
(Inherited from Node)

Methods

NameDescription
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