Bookmark class

Bookmark class

Represents a single bookmark. To learn more, visit the Working with Bookmarks documentation article.

Bookmark is a “facade” object that encapsulates two nodes Bookmark.bookmark_start and Bookmark.bookmark_end in a document tree and allows to work with a bookmark as a single object.

Properties

Name Description
bookmark_end Gets the node that represents the end of the bookmark.
bookmark_start Gets the node that represents the start of the bookmark.
first_column Gets the zero-based index of the first column of the table column range associated with the bookmark.
is_column Returns True if this bookmark is a table column bookmark.
last_column Gets the zero-based index of the last column of the table column range associated with the bookmark.
name Gets or sets the name of the bookmark.
text Gets or sets the text enclosed in the bookmark.

Methods

Name Description
remove() Removes the bookmark from the document. Does not remove text inside the bookmark.

See Also