.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
.NET Core 3.0+

PdfDestination Class

Represents a destination (a particular view of a document) to which a document target (e.g. a bookmark) is referred to.

Namespace: DevExpress.Pdf

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

Declaration

public abstract class PdfDestination :
    PdfObject
Public MustInherit Class PdfDestination
    Inherits PdfObject
public abstract class PdfDestination :
    PdfObject
Public MustInherit Class PdfDestination
    Inherits PdfObject
public abstract class PdfDestination :
    PdfObject
Public MustInherit Class PdfDestination
    Inherits PdfObject

Remarks

You can obtain a page and page index where the destination is located using the PdfDestination.Page and PdfDestination.PageIndex properties.

For more information about the destination creation, see the Bookmarks topic.

Examples

This example shows how to create bookmarks in code.

To do this:

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