Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

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.v24.2.dll

NuGet Package: DevExpress.Win.PdfViewer

#Declaration

public PdfDocumentPosition GetDocumentPosition(
    PointF clientPoint,
    bool inPageBounds
)

#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.

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));
        }
    }
}

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetDocumentPosition(PointF, Boolean) 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.

See Also