PdfBookmark Class

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

Namespace: DevExpress.Pdf

Assembly: DevExpress.Pdf.v21.2.Core.dll

NuGet Package: DevExpress.Pdf.Core

Declaration

C#

public class PdfBookmark :
    IPdfBookmarkParent

VB.NET

Public Class PdfBookmark
    Implements IPdfBookmarkParent

Remarks

An instance of the PdfBookmark class is accessible via the PdfDocument.Bookmarks property.

You can change a bookmark’s attribute (e.g., rename a bookmark using the PdfBookmark.Title property, change the bookmark’s font style using the PdfBookmark.IsBold, PdfBookmark.IsItalic properties, and specify the bookmark destination using the PdfBookmark.Destination property).

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

This example shows how to create bookmarks with destinations in code:

View Example

Program.cs

using DevExpress.Pdf;

using (PdfDocumentProcessor processor = new PdfDocumentProcessor())
{
    // Load a document
    processor.LoadDocument("..\\..\\Document.pdf");

    // Create destinations
    PdfDestination destination1 = processor.CreateDestination(1, 180, 150);
    PdfDestination destination2 = processor.CreateDestination(1, 168, 230);
    PdfDestination destination3 = processor.CreateDestination(1, 20, 350);

    // Associate bookmarks with created destinations
    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 });
    processor.Document.Bookmarks.Add(new PdfBookmark()
         { Title = "Learn More", Destination = destination3 });

    // Save the result document
    processor.SaveDocument("..\\..\\Result.pdf");
}

Program.vb

Imports DevExpress.Pdf

Using processor As New PdfDocumentProcessor()

    ' Load a document
    processor.LoadDocument("..\..\Document.pdf")

    ' Create destinations
    Dim destination1 As PdfDestination = processor.CreateDestination(1, 180, 150)
    Dim destination2 As PdfDestination = processor.CreateDestination(1, 168, 230)
    Dim destination3 As PdfDestination = processor.CreateDestination(1, 20, 350)

    ' Associate bookmarks with created destinations
    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})
    processor.Document.Bookmarks.Add(New PdfBookmark() With
         {.Title = "Learn More", .Destination = destination3})

    ' Save the result document.
    processor.SaveDocument("..\..\Result.pdf")
End Using

Inheritance

Object

PdfBookmark