PdfViewer.GetDocumentPosition(PointF) Method

Converts the specified point coordinates relative to the PDF Viewer’s client area to the page coordinates.

Namespace: DevExpress.XtraPdfViewer

Assembly: DevExpress.XtraPdfViewer.v23.2.dll

NuGet Package: DevExpress.Win.PdfViewer

Declaration

C#

public PdfDocumentPosition GetDocumentPosition(
    PointF clientPoint
)

VB.NET

Public Function GetDocumentPosition(
    clientPoint As PointF
) 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.

Returns

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

Remarks

When the target point is outside page bounds, the GetDocumentPosition method returns the point coordinates that belong to the closest document page.

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

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetDocumentPosition(PointF) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-custom-draw-in-pdf-viewer/CS/CustomDraw/Form1.cs#L23

if (e.Button == MouseButtons.Left) {
    startPosition = pdfViewer1.GetDocumentPosition(e.Location);
    endPosition = null;

VB.NET

how-to-custom-draw-in-pdf-viewer/VB/CustomDraw/Form1.vb#L27

If e.Button = MouseButtons.Left Then
    startPosition = pdfViewer1.GetDocumentPosition(e.Location)
    endPosition = Nothing