General Information
.NET Subscription
Desktop
Web
Controls and Extensions
Mainteinance Mode
Enterprise and Analytic Tools
Quality Assurance and Productivity
Frameworks and Libraries
General Information
.NET Subscription
Desktop
Web
Controls and Extensions
Mainteinance Mode
Enterprise and Analytic Tools
Quality Assurance and Productivity
Frameworks and Libraries
PdfBookmark Class
Contains settings that are used to specify bookmarks in a document.
Namespace: DevExpress.Pdf
Assembly: DevExpress.Pdf.v19.2.Core.dll
Declaration
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.
Examples
This example shows how to create bookmarks in code.
To do this:
- Create a PdfBookmark object;
- Specify the bookmark title and destination using the PdfBookmark.Title and PdfBookmark.Destination properties. To create a destination, call one of the PdfDocumentProcessor.CreateDestination overloaded methods.
- Add the bookmark to the PdfBookmark collection, which is accessed from the PdfDocument.Bookmarks property.
Note
A complete sample project is available at https://github.com/DevExpress-Examples/how-to-add-bookmarks-to-a-document-t495077
using DevExpress.Pdf;
namespace AddBookmarks {
class Program {
static void Main(string[] args) {
using (PdfDocumentProcessor processor = new PdfDocumentProcessor()) {
// Load a document.
processor.LoadDocument("..\\..\\Document.pdf");
// Create bookmarks and add them to the PDF document.
PdfDestination destination1 = processor.CreateDestination(1, 180, 150);
PdfDestination destination2 = processor.CreateDestination(1, 168, 230);
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 });
processor.Document.Bookmarks.Add(new PdfBookmark() { Title = "Learn More", Destination = destination3 });
// Save the result document.
processor.SaveDocument("..\\..\\Result.pdf");
}
}
}
}
Imports DevExpress.Pdf
Namespace AddBookmarks
Friend Class Program
Shared Sub Main(ByVal args() As String)
Using processor As New PdfDocumentProcessor()
' Load a document.
processor.LoadDocument("..\..\Document.pdf")
' Create bookmarks and add them to the PDF document.
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)
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
End Sub
End Class
End Namespace