PdfBookmarkEditor

PdfBookmarkEditor

Overview

PdfBookmarkEditor is a class in Aspose.PDF FOSS for Python. Inherits from: _BoundFacade.

The document’s outline, as the ported API edits it.

This class declares 5 methods for PdfBookmarkEditor objects in Python programs. Available methods include: create_bookmark_of_page, create_bookmarks, delete_bookmarks, extract_bookmarks, walk. Public members are accessible to any Python application after installing the Aspose.PDF FOSS for Python package.

Methods

SignatureDescription
extract_bookmarks(nested: bool) → list[Any]Every top-level bookmark, with its children (nested=False flattens).
walk(entries: list[Any])Calls walk(entries) on this PdfBookmarkEditor instance.
create_bookmark_of_page(title: str, page_number: int) → AnyAdd a top-level bookmark pointing at one page, and return it.
create_bookmarks(titles: Any) → list[Any]Add a bookmark per (title, page_number) pair, in order.
delete_bookmarks(title: str | None) → intDelete every bookmark, or the top-level ones titled title.

See Also