←Select platform

WriteBookmarks Method

Summary

Writes bookmarks (TOC) to an existing PDF file.

Syntax

C++

public void WriteBookmarks( 
   IList<PDFBookmark> bookmarks, 
   string destinationFileName 
)

Public Sub WriteBookmarks( _ 
   ByVal bookmarks As IList(Of PDFBookmark), _ 
   ByVal destinationFileName As String _ 
)

public: 
void WriteBookmarks(  
   IList<PDFBookmark>^ bookmarks, 
   String^ destinationFileName 
)

Parameters

bookmarks
A list of PDFBookmark objects to write. This must not be null and must be a list of 1 or more items. An empty list (count is zero) will throw an exception.

destinationFileName
Name of the destination PDF file to be created. If the value of this parameter is null then the filename set in FileName will be updated.

Remarks

You can use WriteBookmarks method to create a Table of Contents (TOC) for a PDF file. For more information, refer to PDFBookmark.

You can create a bookmarks list from scratch and populate with the bookmarks required, or you can read the bookmarks of a PDF file using PDFDocument.ParseDocumentStructure with the PDFParseDocumentStructureOptions.Bookmarks included in the options parameter. Modify these bookmarks then write them back to the file.

WriteBookmarks does not clear the existing bookmarks, only adds the new objects. To replace the bookmarks in an existing file with new ones, use ClearBookmarks first to delete any existing objects and then WriteBookmarks to add the new objects.

Note that ClearBookmarks will delete all existing bookmarks and any internal links found in the document.

Example

For an example, refer to PDFDocument.ParseDocumentStructure.

Requirements

Target Platforms

Reference

PDFFile Class

PDFFile Members

Help Version 19.0.2017.10.27