PdfBookmark Class

Contains settings that are used to specify bookmarks in a document.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Pdf.v22.1.Core.dll

Declaration

C#

public class PdfBookmark :
    IPdfBookmarkParent

VB.NET

Public Class PdfBookmark
    Implements IPdfBookmarkParent

Remarks

Use the PdfDocument.Bookmarks property to obtain a list of document bookmarks.

Important

The bookmark hierarchy must contain only distinct instances of the PdfBookmark class. The following code snippet shows this prohibited action.

C#

PdfBookmark bookmark = new PdfBookmark();
bookmark.Children.Add(bookmark);

VB.NET

Dim bookmark As PdfBookmark =  New PdfBookmark() 
bookmark.Children.Add(bookmark)

Example

The code sample below creates a bookmark with a destination that displays the eighth page as follows:

C#

using (PdfDocumentProcessor pdfDocumentProcessor = new PdfDocumentProcessor())
{
    // Load a document
    pdfDocumentProcessor.LoadDocument("Demo.pdf");

    // Create a FitB destination that refers to the eighth page
    PdfFitBBoxDestination destination =
       new PdfFitBBoxDestination(pdfDocumentProcessor.Document.Pages[7]);

    // Create a bookmark
    PdfBookmark bookmark = new PdfBookmark();
    bookmark.Title = "Annotations";

    // Associate the bookmark with the created destination
    bookmark.Destination = destination;

    // Add the bookmark to the document collection
    pdfDocumentProcessor.Document.Bookmarks.Add(bookmark);

    // Save the result
    pdfDocumentProcessor.SaveDocument("out.pdf");
}

VB.NET

Using pdfDocumentProcessor As New PdfDocumentProcessor()
  ' Load a document
  pdfDocumentProcessor.LoadDocument("Demo.pdf")

  ' Create a FitB destination that refers to the eighth page
  Dim destination As New PdfFitBBoxDestination
    (pdfDocumentProcessor.Document.Pages(1))

  ' Create a bookmark
  Dim bookmark As New PdfBookmark()
  bookmark.Title = "Annotations"

  ' Associate the bookmark with the created destination
  bookmark.Destination = destination

  ' Add a bookmark to the document collection
  pdfDocumentProcessor.Document.Bookmarks.Add(bookmark)

  ' Save the result
  pdfDocumentProcessor.SaveDocument("out.pdf")
End Using

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the PdfBookmark class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-add-bookmarks-to-a-document-t495077/CS/AddBookmarks/Program.cs#L16

PdfDestination destination3 = processor.CreateDestination(1, 20, 350);
processor.Document.Bookmarks.Add(new PdfBookmark() { Title = "PDF Document Processor", Destination = destination1 });
processor.Document.Bookmarks.Add(new PdfBookmark() { Title = "Display, Print and Export PDF Documents", Destination = destination2 });

how-to-bookmark-search-results-in-a-pdf-document-t350881/CS/Destination/Program.cs#L23

// Get bookmark list.
IList<PdfBookmark> bookmarks = documentProcessor.Document.Bookmarks;
foreach (string word in words) {

VB.NET

how-to-add-bookmarks-to-a-document-t495077/VB/AddBookmarks/Program.vb#L16

Dim destination3 As PdfDestination = processor.CreateDestination(1, 20, 350)
processor.Document.Bookmarks.Add(New PdfBookmark() With {.Title = "PDF Document Processor", .Destination = destination1})
processor.Document.Bookmarks.Add(New PdfBookmark() With {.Title = "Display, Print and Export PDF Documents", .Destination = destination2})

how-to-bookmark-search-results-in-a-pdf-document-t350881/VB/Destination/Program.vb#L23

' Get bookmark list.
Dim bookmarks As IList(Of PdfBookmark) = documentProcessor.Document.Bookmarks
For Each word As String In words

Inheritance

Object

PdfBookmark