PdfViewer.GetDocumentPosition(PointF, Boolean) Method

Converts the specified point coordinates relative to the PDF Viewer’s client area (in pixels) to the page coordinates in a document.

Namespace: DevExpress.XtraPdfViewer

Assembly: DevExpress.XtraPdfViewer.v23.2.dll

NuGet Package: DevExpress.Win.PdfViewer

Declaration

C#

public PdfDocumentPosition GetDocumentPosition(
    PointF clientPoint,
    bool inPageBounds
)

VB.NET

Public Function GetDocumentPosition(
    clientPoint As PointF,
    inPageBounds As Boolean
) As PdfDocumentPosition

Parameters

Name	Type	Description
clientPoint	PointF	A PointF structure, specifying the coordinates of a point (in pixels) relative to the PDF Viewer’s client area.
inPageBounds	Boolean	A Boolean value that determines how the method interprets the point located outside page bounds in a document; if true - when the point is outside page bounds, the method returns the point coordinates that belong to the closest page in a document; false - if the point is outside page bounds, this method returns null.

Returns

Type	Description
PdfDocumentPosition	A PdfDocumentPosition object that returns the page coordinates and the page number in a document.

Example

This example shows how to determine what page was clicked in a document.

Form1.cs

using System.IO;
using System.Reflection;
using System.Windows.Forms;
using DevExpress.Pdf;
using DevExpress.XtraBars.Ribbon;


namespace PageHitTest
{

    public partial class Form1 : RibbonForm
    {
        public Form1()
        {
            InitializeComponent();

            Stream stream = GetResourceStream("PageHitTest.demo.pdf");
            pdfViewer.LoadDocument(stream);
        }

        static Stream GetResourceStream(string resourceName)
        {
            return Assembly.GetExecutingAssembly().GetManifestResourceStream(resourceName);
        }

        void pdfViewer_MouseClick(object sender, MouseEventArgs e)
        {
            PdfDocumentPosition position = pdfViewer.GetDocumentPosition(e.Location, true);
            MessageBox.Show(string.Format("You clicked on page {0}", position.PageNumber));
        }
    }
}

Form1.vb

Imports System.IO
Imports System.Reflection
Imports System.Windows.Forms
Imports DevExpress.Pdf
Imports DevExpress.XtraBars.Ribbon


Namespace PageHitTest

    Partial Public Class Form1
        Inherits RibbonForm

        Public Sub New()
            InitializeComponent()

            Dim stream As Stream = GetResourceStream("PageHitTest.demo.pdf")
            pdfViewer.LoadDocument(stream)
        End Sub

        Private Shared Function GetResourceStream(ByVal resourceName As String) As Stream
            Return System.Reflection.Assembly.GetExecutingAssembly().GetManifestResourceStream(resourceName)
        End Function

        Private Sub pdfViewer_MouseClick(ByVal sender As Object, ByVal e As MouseEventArgs) Handles pdfViewer.MouseClick
            Dim position As PdfDocumentPosition = pdfViewer.GetDocumentPosition(e.Location, True)
            MessageBox.Show(String.Format("You clicked on page {0}", position.PageNumber))
        End Sub
    End Class
End Namespace