RichEditControl.GetBoundsFromPosition(DocumentPosition) Method

Gets the rectangle representing the character at the specified position.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v18.1.dll

Declaration

C#

public Rectangle GetBoundsFromPosition(
    DocumentPosition pos
)

VB.NET

Public Function GetBoundsFromPosition(
    pos As DocumentPosition
) As Rectangle

Parameters

Name	Type	Description
pos	DocumentPosition	A DocumentPosition, specifying the position in the document.

Returns

Type	Description
Rectangle	A Rectangle representing the area occupied by a character or the System.Drawing.Rectangle.Empty value if the bounds could not be determined. Measured in the units that are in effect.

Remarks

You can use the GetBoundsFromPosition method only for the currently visible part of the document. If the specified position is not displayed, the method returns a System.Drawing.Rectangle.Empty value.

The location and size of the resulting rectangle are expressed in measurement the units which are in effect for the current document. To change the unit of measurement, use the Document.Unit property.

Example

The following code highlights the line in which the caret is located. The caret position is determined by the Document.CaretPosition property, the caret screen coordinates are calculated using the RichEditControl.GetBoundsFromPosition method.

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

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-the-richeditcontrols-common-api-t210437

RichEditControlActions.cs

static void richEditControl_Paint(object sender, System.Windows.Forms.PaintEventArgs e) {
    RichEditControl richEdit = sender as RichEditControl;
    DocumentPosition pos = richEdit.Document.CaretPosition;
    if(pos != null) {
        System.Drawing.Rectangle rect = DevExpress.Office.Utils.Units.DocumentsToPixels(
            richEdit.GetBoundsFromPosition(pos), 
            richEdit.DpiX, 
            richEdit.DpiY);

        Section firstSection = richEdit.Document.Sections[0];
        int pageWidth = Convert.ToInt32(firstSection.Page.Width - firstSection.Margins.Left - firstSection.Margins.Right);
        e.Graphics.DrawLine(System.Drawing.Pens.Red, 
            new System.Drawing.Point(0, rect.Bottom), 
            new System.Drawing.Point(pageWidth, rect.Bottom));
    }
}

RichEditControlActions.vb

Private Shared Sub richEditControl_Paint(ByVal sender As Object, ByVal e As System.Windows.Forms.PaintEventArgs)
    Dim richEdit As RichEditControl = TryCast(sender, RichEditControl)
    Dim pos As DocumentPosition = richEdit.Document.CaretPosition
    If pos IsNot Nothing Then
        Dim rect As System.Drawing.Rectangle = DevExpress.Office.Utils.Units.DocumentsToPixels(
            richEdit.GetBoundsFromPosition(pos),
            richEdit.DpiX,
            richEdit.DpiY)

        Dim firstSection As Section = richEdit.Document.Sections(0)
        Dim pageWidth As Integer = Convert.ToInt32(firstSection.Page.Width - firstSection.Margins.Left - firstSection.Margins.Right)
        e.Graphics.DrawLine(System.Drawing.Pens.Red,
                            New System.Drawing.Point(0, rect.Bottom),
                            New System.Drawing.Point(pageWidth, rect.Bottom))
    End If
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetBoundsFromPosition(DocumentPosition) 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-perform-drag-and-drop-operation-in-a-custom-manner-e2943/CS/Form1.cs#L46

Rectangle rect = Units.DocumentsToPixels(richEditControl1.GetBoundsFromPosition(pos),
    richEditControl1.DpiX, richEditControl1.DpiY);

how-to-highlight-the-current-row-in-the-richeditcontrol-e4435/CS/Form1.cs#L18

DocumentRange range = richEditControl1.Document.Selection;
Rectangle rect = richEditControl1.GetBoundsFromPosition(range.Start);

how-to-insert-a-file-content-into-a-document-via-drag-and-drop-e3489/CS/Form1.cs#L32

if(pos != null) {
    Rectangle rect = Units.DocumentsToPixels(richEditControl1.GetBoundsFromPosition(pos),
        richEditControl1.DpiX, richEditControl1.DpiY);

how-to-implement-an-ms-word-like-mini-toolbar-in-richeditcontrol-t157245/CS/RTFRibbonMini/Form1.cs#L36

DocumentPosition documentPosition = richEditControl1.Document.CaretPosition;
Rectangle documentRectangle = richEditControl1.GetBoundsFromPosition(documentPosition);
Point documentPoint = new Point(documentRectangle.Left, documentRectangle.Bottom);

how-to-drag-and-drop-gridview-cell-data-to-a-richeditcontrol-document-t267756/CS/DragDropExample/Form1.cs#L117

Rectangle rect = Units.DocumentsToPixels(richEditControl1.GetBoundsFromPosition(pos),
    richEditControl1.DpiX, richEditControl1.DpiY);

VB.NET

how-to-perform-drag-and-drop-operation-in-a-custom-manner-e2943/VB/Form1.vb#L51

Dim rect As Rectangle = Units.DocumentsToPixels(richEditControl1.GetBoundsFromPosition(pos), richEditControl1.DpiX, richEditControl1.DpiY)

how-to-highlight-the-current-row-in-the-richeditcontrol-e4435/VB/Form1.vb#L20

Dim range As DocumentRange = richEditControl1.Document.Selection
Dim rect As Rectangle = richEditControl1.GetBoundsFromPosition(range.Start)

how-to-insert-a-file-content-into-a-document-via-drag-and-drop-e3489/VB/Form1.vb#L35

If pos IsNot Nothing Then
    Dim rect As Rectangle = Units.DocumentsToPixels(richEditControl1.GetBoundsFromPosition(pos), richEditControl1.DpiX, richEditControl1.DpiY)

how-to-implement-an-ms-word-like-mini-toolbar-in-richeditcontrol-t157245/VB/RTFRibbonMini/Form1.vb#L38

Dim documentPosition As DocumentPosition = richEditControl1.Document.CaretPosition
Dim documentRectangle As Rectangle = richEditControl1.GetBoundsFromPosition(documentPosition)
Dim documentPoint As New Point(documentRectangle.Left, documentRectangle.Bottom)

how-to-drag-and-drop-gridview-cell-data-to-a-richeditcontrol-document-t267756/VB/DragDropExample/Form1.vb#L108

Dim rect As Rectangle = Units.DocumentsToPixels(richEditControl1.GetBoundsFromPosition(pos), richEditControl1.DpiX, richEditControl1.DpiY)