PdfDocumentPosition Class

Represents a point in the page coordinates of the PDF document.

Namespace: DevExpress.Pdf

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

Declaration

C#

public class PdfDocumentPosition

VB.NET

Public Class PdfDocumentPosition

Related API Members

The following members accept/return PdfDocumentPosition objects:

Library	Related API Members
WinForms Controls	PdfSelectionEventArgs.DocumentPosition
	PdfViewer.GetDocumentPosition(PointF)
	PdfViewer.GetDocumentPosition(PointF, Boolean)
WPF Controls	PdfHitTestResult.DocumentPosition
	PdfViewerControl.ConvertPixelToDocumentPosition(Point)
	PdfViewerControl.ConvertPixelToDocumentPosition(Point, Boolean)
	SelectionEventArgs.DocumentPosition
Office File API	PdfDocumentContent.DocumentPosition
Windows 10 App Controls	PdfViewerControl.ClientToDocument(Point)

Related API Members

The following members accept/return PdfDocumentPosition objects:

Library	Related API Members
WinForms Controls	PdfSelectionEventArgs.DocumentPosition
	PdfViewer.GetDocumentPosition(PointF)
	PdfViewer.GetDocumentPosition(PointF, Boolean)
WPF Controls	PdfHitTestResult.DocumentPosition
	PdfViewerControl.ConvertPixelToDocumentPosition(Point)
	PdfViewerControl.ConvertPixelToDocumentPosition(Point, Boolean)
	SelectionEventArgs.DocumentPosition
Office File API	PdfDocumentContent.DocumentPosition
Windows 10 App Controls	PdfViewerControl.ClientToDocument(Point)

Remarks

Use PdfDocumentPosition objects to obtain the position in page coordinate system. The following API uses the PdfDocumentPosition object:

PDF Document API:

• PdfDocumentContent.DocumentPosition
• PdfDocumentArea.Create
• PdfDocumentProcessor.GetImages
• PdfDocumentProcessor.GetText
• PdfDocumentProcessor.GetWord

WinForms PDF Viewer

• PdfViewer.SelectWord
• PdfViewer.Select
• PdfSelectionEventArgs.DocumentPosition

Converters:

• PdfViewer.GetDocumentPosition
• PdfViewer.GetClientPoint

WPF PDF Viewer

• PdfViewerControl.SelectWord
• PdfViewerControl.Select
• PdfViewerControl.GetText

Converters:

• PdfViewerControl.ConvertDocumentPositionToPixel
• PdfViewerControl.ConvertPixelToDocumentPosition

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the PdfDocumentPosition class.

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-draw-a-rectangle-over-a-PDF-document/CS/WpfApplication1/PdfSelectionChangedEventArgs.cs#L10

{
    public PdfDocumentPosition StartPosition { get; private set; }
    public PdfDocumentPosition EndPosition { get; private set; }

How-to-read-and-display-comments-from-a-PDF-file/CS/WindowsFormsApplication2/XtraForm1.cs#L42

{
    PdfDocumentPosition position = (PdfDocumentPosition)element.Tag;
    pdfViewer1.EnsureVisibility(position);

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

bool mouseButtonPressed = false;
PdfDocumentPosition startPosition;
PdfDocumentPosition endPosition;

how-to-add-a-text-markup-annotation-to-pdf-T545395/CS/CreateMarkupAnnotation/Program.cs#L31

//Add a text markup annotation at the first page:
PdfDocumentPosition startPosition = new PdfDocumentPosition(1, new PdfPoint(113, 224));
PdfDocumentPosition endPosition = new PdfDocumentPosition(1, new PdfPoint(272, 207));

how-to-determine-the-page-number-of-a-clicked-pdf-page-t121897/CS/PageHitTest/Form1.cs#L23

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

VB.NET

-How-to-draw-a-rectangle-over-a-PDF-document/VB/WpfApplication1/PdfSelectionChangedEventArgs.vb#L10

Private privateStartPosition As PdfDocumentPosition
Public Property StartPosition() As PdfDocumentPosition

How-to-read-and-display-comments-from-a-PDF-file/VB/WindowsFormsApplication2/XtraForm1.vb#L44

Private Sub SelectTextAnnotation(ByVal element As AccordionControlElement)
    Dim position As PdfDocumentPosition = CType(element.Tag, PdfDocumentPosition)
    pdfViewer1.EnsureVisibility(position)

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

'INSTANT VB NOTE: The field startPosition was renamed since Visual Basic does not allow fields to have the same name as other class members:
        Private startPosition_Conflict As PdfDocumentPosition
        Private endPosition As PdfDocumentPosition

how-to-add-a-text-markup-annotation-to-pdf-T545395/VB/CreateMarkupAnnotation/Program.vb#L26

'Add a text markup annotation at the first page:
Dim startPosition As New PdfDocumentPosition(1, New PdfPoint(113, 224))
Dim endPosition As New PdfDocumentPosition(1, New PdfPoint(272, 207))

how-to-determine-the-page-number-of-a-clicked-pdf-page-t121897/VB/PageHitTest/Form1.vb#L25

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

Inheritance

Object

PdfDocumentPosition