BookmarksNavigator module

class BookmarksNavigator.BookmarksNavigator

Bases: SpireObject

Represents a bookmarks navigator.

property CurrentBookmark: Bookmark

Gets the current bookmark in the bookmarks navigator.

Returns:

The current bookmark in the bookmarks navigator.

Return type:

Bookmark

DeleteBookmarkContent(saveFormatting: bool)

Deletes the content of the current bookmark in the bookmarks navigator.

Parameters:

saveFormatting (bool) – True to save the formatting of the deleted content, False otherwise.

property Document: IDocument

Gets or sets the document associated with the bookmarks navigator.

Returns:

The document associated with the bookmarks navigator.

Return type:

IDocument

GetBookmarkContent() → TextBodyPart

Gets the content of the current bookmark in the bookmarks navigator.

Returns:

The content of the current bookmark.

Return type:

TextBodyPart

InsertParagraph(paragraph: IParagraph)

Inserts the specified paragraph at the current position of the bookmarks navigator.

Parameters:

paragraph (IParagraph) – The paragraph to insert.

InsertParagraphItem(itemType: ParagraphItemType) → IParagraphBase

Inserts a paragraph item of the specified type at the current position of the bookmarks navigator.

Parameters:

itemType (ParagraphItemType) – The type of the paragraph item to insert.

Returns:

The inserted paragraph item.

Return type:

IParagraphBase

InsertTable(table: ITable)

Inserts the specified table at the current position of the bookmarks navigator.

Parameters:

table (ITable) – The table to insert.

InsertText

Inserts the specified text at the current position of the bookmarks navigator.

Parameters:

text (str) – The text to insert.

Returns:

The inserted text range.

Return type:

ITextRange

InsertTextBodyPart(bodyPart: TextBodyPart)

Inserts the specified text body part at the current position of the bookmarks navigator.

Parameters:

bodyPart (TextBodyPart) – The text body part to insert.

MoveToBookmark

Moves the bookmarks navigator to the specified bookmark.

Parameters:

bookmarkName (str) – The name of the bookmark to move to.

ReplaceBookmarkContent

Replaces the content of the current bookmark with the specified text body part.

Parameters:

bodyPart (TextBodyPart) – The text body part to replace with.