PdfBookmark.Destination Property
Gets or sets a destination (a particular view of a document) to which a bookmark is referred to.
Namespace: DevExpress.Pdf
Assembly: DevExpress.Pdf.v21.1.Core.dll
NuGet Package: DevExpress.Pdf.Core
Declaration
Property Value
Type | Description |
---|---|
PdfDestination | A PdfDestination object that is a bookmark destination. |
Remarks
The Destination property specifies a destination that shows a particular document view after the bookmark is clicked in the navigation panel. You can create a bookmark destination in the PDF Document Processor by calling one of the overloaded PdfDocumentProcessor.CreateDestination methods.
To specify a bookmark title, use the PdfBookmark.Title property.
To learn more about the bookmarks creation, see the Bookmarks topic.
Example
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.
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");
}
}
}
}