PdfViewer.Select(RectangleF) Method

Selects the document content located in the specified rectangle.

Namespace: DevExpress.XtraPdfViewer

Assembly: DevExpress.XtraPdfViewer.v19.1.dll

Declaration

C#

public void Select(
    RectangleF clientRectangle
)

VB.NET

Public Sub Select(
    clientRectangle As RectangleF
)

Parameters

Name	Type	Description
clientRectangle	RectangleF	A RectangleF structure that is the target rectangle.

Remarks

The overloaded Select method uses the client coordinate system. Refer to the Coordinate Systems topic for more information.

The code sample below shows how to copy selected text to the Clipboard.

C#

bool mouseButtonPressed = false;
PdfDocumentPosition startPosition;
PdfDocumentPosition endPosition;

void pdfViewer1_MouseDown(object sender, MouseEventArgs e)
{
  if (e.Button == MouseButtons.Left)
  {
      //Retrieve the initial mouse position
      startPosition = pdfViewer1.GetDocumentPosition(e.Location);
      endPosition = null;
      mouseButtonPressed = true;
      pdfViewer1.Invalidate();
  }
}

void pdfViewer1_MouseMove(object sender, MouseEventArgs e)
{
  if (mouseButtonPressed)
  {
      //Obtain the final position
      endPosition = pdfViewer1.GetDocumentPosition(e.Location);
      pdfViewer1.Invalidate();
  }
}


void pdfViewer1_MouseUp(object sender, MouseEventArgs e)
{
    mouseButtonPressed = false;
    if (startPosition == null || endPosition == null)
        return;
    var start = pdfViewer1.GetClientPoint(startPosition);
    var end = pdfViewer1.GetClientPoint(endPosition);
    RectangleF rect = new RectangleF(Math.Min(start.X, end.X),
        Math.Min(start.Y, end.Y),
        Math.Abs(start.X - end.X),
        Math.Abs(start.Y - end.Y));


    //Select the content located in the target rectangle
    pdfViewer1.Select(rect);
    PdfSelectionContent content = pdfViewer1.GetSelectionContent();
    if (content.ContentType == PdfSelectionContentType.Text)

    //Copy selection to Clipboard
        pdfViewer1.CopyToClipboard();
    MessageBox.Show("The selection is copied to Clipboard");
}

VB.NET

  Private mouseButtonPressed As Boolean = False
  Private startPosition As PdfDocumentPosition
  Private endPosition As PdfDocumentPosition

Private Sub pdfViewer1_MouseDown(ByVal sender As Object, ByVal e As MouseEventArgs)
    If e.Button = MouseButtons.Left Then

        'Retrieve the initial mouse position
        startPosition = pdfViewer1.GetDocumentPosition(e.Location)
        endPosition = Nothing
        mouseButtonPressed = True
        pdfViewer1.Invalidate()
    End If
End Sub

Private Sub pdfViewer1_MouseMove(ByVal sender As Object, ByVal e As MouseEventArgs)
    If mouseButtonPressed Then

        'Retrieve the final position
        endPosition = pdfViewer1.GetDocumentPosition(e.Location)
        pdfViewer1.Invalidate()
    End If
End Sub

Private Sub pdfViewer1_MouseUp(ByVal sender As Object, ByVal e As MouseEventArgs)
    mouseButtonPressed = False
    If startPosition Is Nothing OrElse endPosition Is Nothing Then Return
    Dim start = pdfViewer1.GetClientPoint(startPosition)
    Dim [end] = pdfViewer1.GetClientPoint(endPosition)
    Dim rect As RectangleF = New RectangleF(Math.Min(start.X, [end].X), Math.Min(start.Y, [end].Y), Math.Abs(start.X - [end].X), Math.Abs(start.Y - [end].Y))

    'Select the content located in the target rectangle
    pdfViewer1.[Select](rect)
    Dim content As PdfSelectionContent = pdfViewer1.GetSelectionContent()

    'Copy selection to Clipboard
    If content.ContentType = PdfSelectionContentType.Text Then pdfViewer1.CopyToClipboard()
    MessageBox.Show("The selection is copied to Clipboard")
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Select(RectangleF) 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-create-a-text-markup-annotation-programmatically-t551899/CS/CreateMarkupAnnotation/Form1.cs#L13

// Select the document area where the markup annotation will be created.
pdfViewer1.Select(new RectangleF(-230, 420, 1240, 150));

VB.NET

how-to-create-a-text-markup-annotation-programmatically-t551899/VB/CreateMarkupAnnotation/Form1.vb#L15

' Select the document area where the markup annotation will be created.
pdfViewer1.Select(New RectangleF(-230, 420, 1240, 150))