Bookmarks Property

Summary

Gets the Table of Contents (TOC) of this PDF document.

Syntax

C++

Java

public IList<PDFBookmark> Bookmarks { get; }

Public ReadOnly Property Bookmarks As IList(Of PDFBookmark)

public List<PDFBookmark> getBookmarks()

public: 
property IList<PDFBookmark>^ Bookmarks { 
   IList<PDFBookmark>^ get(); 
}

Property Value

A list of PDFBookmark objects that specify the Table of Contents (TOC) of this PDFDocument. The default value is null.

Remarks

Use ParseDocumentStructure to parse the document structure of the PDF document. The document structure is the Table of Contents (TOC) and is represented by a list of PDF bookmark objects stored in the Bookmarks property and the internal links between pages (or jumps) found in the document stored in the InternalLinks property.

When you first create an instance of PDFDocument, both InternalLinks and Bookmarks will be initialized to null . You must call ParseDocumentStructure with the desired PDFParseDocumentStructureOptions passed to the options parameters. When this method returns, the InternalLinks and Bookmarks will be populated accordingly.

To write bookmarks to a PDF file, use the PDFFile.WriteBookmarks method.

Example

For an example, refer to ParseDocumentStructure.

Requirements

Target Platforms