PdfDocument.Bookmarks Property
Gets or sets the bookmarks that are used to navigate from one part of a document to another.
Namespace: DevExpress.Pdf
Assembly: DevExpress.Pdf.v19.1.Core.dll
Declaration
Property Value
Type | Description |
---|---|
IList<PdfBookmark> | A list of PdfBookmark objects that are the collection of bookmarks. |
Remarks
A list of bookmarks can’t be null. If you set the Bookmarks property to null, the null reference exception occurs.
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.
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");
}
}
}
}
See Also