PdfXYZDestination Class

Represents a destination that displays the PDF page with the PdfXYZDestination.Left, PdfXYZDestination.Top coordinates positioned at the upper-left corner of the window and the contents of the page magnified by the factor zoom (the PdfXYZDestination.Zoom property).

Namespace: DevExpress.Pdf

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

Declaration

C#

public class PdfXYZDestination :
    PdfDestination

VB.NET

Public Class PdfXYZDestination
    Inherits PdfDestination

Remarks

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

Example

This example shows how to create a bookmark with a destination corresponding to the found text in a document.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-bookmark-search-results-in-a-pdf-document-t350881

Program.vb

Imports System.Collections.Generic
Imports DevExpress.Pdf

Namespace Destination
    Friend Class Program

        Shared Sub Main(ByVal args() As String)
            ' Create a PDF document processor.
            Using documentProcessor As New PdfDocumentProcessor()

                ' Define search words.
                Dim words() As String = { "DX-B5000", "DX-RX800" }

                ' Load a PDF document. 
                documentProcessor.LoadDocument("..\..\Document.pdf")

                ' Specify the search parameters.
                Dim searchParameters As New PdfTextSearchParameters()
                searchParameters.CaseSensitive = True
                searchParameters.WholeWords = True

                ' Get bookmark list. 
                Dim bookmarks As IList(Of PdfBookmark) = documentProcessor.Document.Bookmarks
                For Each word As String In words
                    ' Get the search results from the FindText method called with search text and search parameters.
                    Dim results As PdfTextSearchResults = documentProcessor.FindText(word, searchParameters)

                    ' If the desired text is found, create a destination that corresponds to the found text
                    ' to be displayed at the upper corner of the window.
                    If results.Status = PdfTextSearchStatus.Found Then
                        Dim destination As New PdfXYZDestination(results.Page, 0, results.Rectangles(0).Top, Nothing)

                        ' Create a bookmark with the search word shown as title and the destination.      
                        Dim bookmark As New PdfBookmark() With {.Title = word, .Destination = destination}

                        ' Add the bookmark to the bookmark list.
                        bookmarks.Add(bookmark)
                    End If
                Next word
                ' Save the modified document.
                documentProcessor.SaveDocument("..\..\Result.pdf")
            End Using
        End Sub
    End Class
End Namespace

Program.cs

using System.Collections.Generic;
using DevExpress.Pdf;

namespace Destination {
    class Program {

        static void Main(string[] args) {
            // Create a PDF document processor.
            using (PdfDocumentProcessor documentProcessor = new PdfDocumentProcessor()) {

                // Define search words.
                string[] words = { "DX-B5000", "DX-RX800" };

                // Load a PDF document. 
                documentProcessor.LoadDocument(@"..\..\Document.pdf");

                // Specify the search parameters.
                PdfTextSearchParameters searchParameters = new PdfTextSearchParameters();
                searchParameters.CaseSensitive = true;
                searchParameters.WholeWords = true;

                // Get bookmark list. 
                IList<PdfBookmark> bookmarks = documentProcessor.Document.Bookmarks;
                foreach (string word in words) {
                    // Get the search results from the FindText method called with search text and search parameters.
                    PdfTextSearchResults results = documentProcessor.FindText(word, searchParameters);

                    // If the desired text is found, create a destination that corresponds to the found text
                    // to be displayed at the upper corner of the window.
                    if (results.Status == PdfTextSearchStatus.Found) {
                        PdfXYZDestination destination = new PdfXYZDestination(results.Page, 0, results.Rectangles[0].Top, null);

                        // Create a bookmark with the search word shown as title and the destination.      
                        PdfBookmark bookmark = new PdfBookmark() { Title = word, Destination = destination };

                        // Add the bookmark to the bookmark list.
                        bookmarks.Add(bookmark);
                    }
                }
                // Save the modified document.
                documentProcessor.SaveDocument(@"..\..\Result.pdf");
            }
        }
    }
}

Inheritance

Object

DevExpress.Pdf.Native.PdfDocumentItem

DevExpress.Pdf.Native.PdfObject

PdfDestination

PdfXYZDestination