PdfDocumentProcessor.CreateDestination(Int32, Single, Single, Single) Method

Creates a destination for targets in the document (e.g., bookmarks) using a page number, page coordinates, and zoom factor.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Docs.v23.2.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public PdfDestination CreateDestination(
    int pageNumber,
    float x,
    float y,
    float zoomFactor
)

VB.NET

Public Function CreateDestination(
    pageNumber As Integer,
    x As Single,
    y As Single,
    zoomFactor As Single
) As PdfDestination

Parameters

Name	Type	Description
pageNumber	Int32	An integer value that is the page number where the destination is created.
x	Single	A Single object that is the horizontal page coordinate value.
y	Single	A Single object that is the vertical page coordinate value.
zoomFactor	Single	The zoom level by which a page destination is created.

Returns

Type	Description
PdfDestination	A PdfDestination object that is the page destination.

Remarks

The overloaded CreateDestination method converts world coordinates to page coordinates. See the Coordinate Systems topic to learn more.

Use this method to create a destination that points to a specific location and view in a document. The created destination is assigned to the PdfBookmark.Destination property.

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

Example

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

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