LEADTOOLS PDF (Leadtools.Pdf assembly)
LEAD Technologies, Inc

Bookmarks Property






Gets the Table of Contents (TOC) of this PDF document.
Syntax
public IList<PDFBookmark> Bookmarks {get;}
'Declaration
 
Public ReadOnly Property Bookmarks As IList(Of PDFBookmark)
'Usage
 
Dim instance As PDFDocument
Dim value As IList(Of PDFBookmark)
 
value = instance.Bookmarks
 get_Bookmarks(); 
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. Default value is null (Nothing in Visual Basic).
Remarks

Use ParseDocumentStructure to parse the document structure of the PDF document. The document structure is the Table of Contents (TOC) 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 (Nothing in Visual Basic). 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: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

PDFDocument Class
PDFDocument Members
InternalLinks Property

 

 


Products | Support | Contact Us | Copyright Notices

© 2006-2012 All Rights Reserved. LEAD Technologies, Inc.