WriteBookmarks Method

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

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

'Usage
 
Dim instance As PDFFile
Dim bookmarks As IList(Of PDFBookmark)
Dim destinationFileName As String
 
instance.WriteBookmarks(bookmarks, destinationFileName)

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

Parameters

bookmarks

A list of PDFBookmark objects to write.

destinationFileName

Name of the destination PDF file to be created. If the value of this parameter is null (Nothing in Visual Basic) then the file name set in FileName will be updated.

You can use this 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.

For an example, refer to PDFDocument.ParseDocumentStructure.

Target Platforms

Reference

PDFFile Class
PDFFile Members