Outlines & Bookmarks

from ironpdf import *

# Create a new PDF or edit an existing document.
pdf = PdfDocument.FromFile("existing.pdf")

# Add bookmark
pdf.Bookmarks.AddBookMarkAtEnd("Author's Note", 2)
pdf.Bookmarks.AddBookMarkAtEnd("Table of Contents", 3)

# Store new bookmark in a variable to add nested bookmarks to
summaryBookmark = pdf.Bookmarks.AddBookMarkAtEnd("Summary", 17)

# Add a sub-bookmark within the summary
conclusionBookmark = summaryBookmark.Children.AddBookMarkAtStart("Conclusion", 18)

# Add another bookmark to end of highest-level bookmark list
pdf.Bookmarks.AddBookMarkAtEnd("References", 20)

pdf.SaveAs("existing.pdf")

pip install ironpdf

pip install ironpdf

Outlines & Bookmarks

IronPDF for Python can add a navigable bookmark outline to PDF documents, creating a table of contents panel that readers can use to jump directly to any section - including nested sub-sections.

Getting Started

Load or create a PdfDocument, then use the pdf.Bookmarks collection to add bookmark entries. Call AddBookMarkAtEnd to append entries to the bookmark list, or AddBookMarkAtStart on a child collection to nest sub-bookmarks beneath a parent.

Understanding the Code

pdf.Bookmarks.AddBookMarkAtEnd(title, pageIndex): Appends a new bookmark to the end of the top-level bookmark list. pageIndex is the zero-based page index the bookmark links to. Returns the new bookmark object.
bookmark.Children.AddBookMarkAtStart(title, pageIndex): Adds a child bookmark under an existing bookmark, creating a nested hierarchy. Returns the child bookmark object.
pdf.Bookmarks.AddBookMarkAtEnd("References", 20): Appends another bookmark after all existing entries.
SaveAs(path): Saves the document with all bookmarks embedded in the PDF outline.

Bookmark Hierarchy

PDF bookmarks support multiple nesting levels. Each bookmark returned by AddBookMarkAtEnd or AddBookMarkAtStart has its own .Children collection, allowing you to build trees of arbitrary depth.