RichEditControl.GetPositionFromPoint(PointF) Method

Gets the position in the document closest to the specified point.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v23.2.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.RichEdit, DevExpress.Win.TreeMap

Declaration

C#

public DocumentPosition GetPositionFromPoint(
    PointF clientPoint
)

VB.NET

Public Function GetPositionFromPoint(
    clientPoint As PointF
) As DocumentPosition

Parameters

Name	Type	Description
clientPoint	PointF	A PointF object that specifies a point in the RichEditControl window.

Returns

Type	Description
DocumentPosition	A DocumentPosition object representing a position in the document.

Remarks

The GetPositionFromPoint method returns the closest document position for a specified point or null reference (Nothing in Visual Basic). The coordinate system origin is located at the upper left corner of the RichEditControl. Use the Units.PixelsToDocuments method to translate coordinates.

The Point Coordinate Units

The measurement logic of RichEditControl uses the units specified by the RichEditControl.Unit property. If this property is set to a value other than DocumentUnit.Document, convert the point coordinates to the specified units. The Units class method allows you to convert between measurement units.

If you handle the DragDrop, DragEnter, or DragOver event, an additional conversion step is required. The X and Y properties of the DragEventArgs are in screen coordinates, not client coordinates. Use the PointToClient(Point) method of the RichEditControl to convert a point with coordinates taken from the DragEventArgs to client coordinates.

Example

The following code gets the mouse position and displays coordinates in a tooltip.

The RichEditControl instance is passed to the BarItem.ItemClick event handler using the BarItem.Tag property.

View Example

RichEditControlActions.cs

static DevExpress.Utils.ToolTipController testToolTipController = new DevExpress.Utils.ToolTipController();

static void richEditControl1_MouseMove(object sender, System.Windows.Forms.MouseEventArgs e) {
    RichEditControl richEdit = sender as RichEditControl;
    System.Drawing.Point docPoint = 
        DevExpress.Office.Utils.Units.PixelsToDocuments(e.Location, richEdit.DpiX, richEdit.DpiY);

    DocumentPosition pos = richEdit.GetPositionFromPoint(docPoint);
    if(pos == null) return;
    string currentToolTipText = String.Format("Position: {0}, Character: {1}", pos.ToString(), 
        richEdit.Document.GetText(richEdit.Document.CreateRange(pos, 1)));

    DevExpress.Utils.ToolTipControlInfo info = 
        new DevExpress.Utils.ToolTipControlInfo(currentToolTipText, currentToolTipText);
    info.ToolTipPosition = System.Windows.Forms.Form.MousePosition;
    testToolTipController.ShowHint(info);
}

RichEditControlActions.vb

Private Shared testToolTipController As New DevExpress.Utils.ToolTipController()

Private Shared Sub richEditControl1_MouseMove(ByVal sender As Object, ByVal e As System.Windows.Forms.MouseEventArgs)
    Dim richEdit As RichEditControl = TryCast(sender, RichEditControl)
    Dim docPoint As System.Drawing.Point =
        DevExpress.Office.Utils.Units.PixelsToDocuments(e.Location, richEdit.DpiX, richEdit.DpiY)

    Dim pos As DocumentPosition = richEdit.GetPositionFromPoint(docPoint)
    If pos Is Nothing Then
        Return
    End If
    Dim currentToolTipText As String = String.Format("Position: {0}, Character: {1}", pos.ToString(),
                                                     richEdit.Document.GetText(richEdit.Document.CreateRange(pos, 1)))

    Dim info As New DevExpress.Utils.ToolTipControlInfo(currentToolTipText, currentToolTipText)
    info.ToolTipPosition = System.Windows.Forms.Form.MousePosition
    testToolTipController.ShowHint(info)
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetPositionFromPoint(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#

winforms-richedit-perform-drag-and-drop-from-list-box/CS/Form1.cs#L41

DocumentPosition pos = richEditControl1.GetPositionFromPoint(docPoint);

winforms-richedit-obtain-the-document-position-under-the-mouse-cursor/CS/RichEdit_GetPositionFromPoint/Form1.cs#L24

richEditControl1.DpiX, richEditControl1.DpiY);
    DocumentPosition pos = richEditControl1.GetPositionFromPoint(docPoint);
    if (pos != null)

winforms-richedit-rich-drag-and-drop-gridview-cell-data/CS/DragDropExample/Form1.cs#L114

DocumentPosition pos = richEditControl1.GetPositionFromPoint(docPoint);
if (pos == null) return;

winforms-richeditcontrol-common-api/CS/RichEditAPISample/CodeExamples/RichEditControlActions.cs#L333

DocumentPosition pos = richEdit.GetPositionFromPoint(docPoint);
if(pos == null) return;

winforms-richedit-document-api/CS/RichEditAPISample/Form1.cs#L555

Point docPoint = Units.PixelsToDocuments(e.Location, richEditControl.DpiX, richEditControl.DpiY);
DocumentPosition pos = richEditControl.GetPositionFromPoint(docPoint);
if (pos != null)

VB.NET

winforms-richedit-perform-drag-and-drop-from-list-box/VB/Form1.vb#L35

Dim docPoint As Point = Units.PixelsToDocuments(richEditControl1.PointToClient(MousePosition), richEditControl1.DpiX, richEditControl1.DpiY)
Dim pos As DocumentPosition = richEditControl1.GetPositionFromPoint(docPoint)
If pos Is Nothing Then Return

winforms-richedit-obtain-the-document-position-under-the-mouse-cursor/VB/RichEdit_GetPositionFromPoint/Form1.vb#L23

Dim docPoint As Point = Units.PixelsToDocuments(e.Location, richEditControl1.DpiX, richEditControl1.DpiY)
Dim pos As DocumentPosition = richEditControl1.GetPositionFromPoint(docPoint)
If pos IsNot Nothing Then

winforms-richedit-rich-drag-and-drop-gridview-cell-data/VB/DragDropExample/Form1.vb#L98

Dim docPoint As Point = Units.PixelsToDocuments(richEditControl1.PointToClient(New Point(e.X, e.Y)), richEditControl1.DpiX, richEditControl1.DpiY)
Dim pos As DocumentPosition = richEditControl1.GetPositionFromPoint(docPoint)
If pos Is Nothing Then Return

winforms-richeditcontrol-common-api/VB/RichEditAPISample/CodeExamples/RichEditControlActions.vb#L340

Dim pos As DocumentPosition = richEdit.GetPositionFromPoint(docPoint)
If pos Is Nothing Then

winforms-richedit-document-api/VB/RichEditAPISample/Form1.vb#L522

Dim docPoint As Point = Units.PixelsToDocuments(e.Location, richEditControl.DpiX, richEditControl.DpiY)
Dim pos As DocumentPosition = richEditControl.GetPositionFromPoint(docPoint)
If pos IsNot Nothing Then