RichEditView.GetDocumentLayoutPosition(Point) Method

Obtains the page index and the layout position on the page for the specified point.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.RichEdit.v19.1.Core.dll

Declaration

C#

public PageLayoutPosition GetDocumentLayoutPosition(
    Point point
)

VB.NET

Public Function GetDocumentLayoutPosition(
    point As Point
) As PageLayoutPosition

Parameters

Name	Type	Description
point	Point	A Point object that is the point in control coordinates.

Returns

Type	Description
PageLayoutPosition	A PageLayoutPosition object containing the page index and the position on a page.

Remarks

The PageLayoutPosition.Position obtained using the GetDocumentLayoutPosition method corresponds to layout element coordinates accessible via the LayoutElement.Bounds property.

Example

When the mouse hovers over the RichEdit view, this code snippet displays the PageLayoutPosition.PageIndex of the page and the position PageLayoutPosition.Position under the mouse cursor on the page.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/layout-api-treeview-example-t239200

Form1.cs

void richEditControl1_MouseMove(object sender, MouseEventArgs e)
{
    PageLayoutPosition pos = richEditControl1.ActiveView.GetDocumentLayoutPosition(e.Location);
    if (pos != null)
        this.barStaticItem1.Caption = System.String.Format("Mouse is over page {0}, position {1}", pos.PageIndex, pos.Position);
    else this.barStaticItem1.Caption = "";
}

Form1.vb

Private Sub richEditControl1_MouseMove(ByVal sender As Object, ByVal e As MouseEventArgs)
    Dim pos As PageLayoutPosition = richEditControl1.ActiveView.GetDocumentLayoutPosition(e.Location)
    If pos IsNot Nothing Then
        Me.barStaticItem1.Caption = System.String.Format("Mouse is over page {0}, position {1}", pos.PageIndex, pos.Position)
    Else
        Me.barStaticItem1.Caption = ""
    End If
End Sub

Related GitHub Examples

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

layout-api-treeview-example-t239200/CS/LayoutApiSample/Form1.cs#L36

{
    PageLayoutPosition pos = richEditControl1.ActiveView.GetDocumentLayoutPosition(e.Location);
    if (pos != null)

how-to-insert-a-checkbox-into-a-richeditcontrol-document-t600135/CS/RichEditControl_CheckBox/Form1.cs#L35

{
    PageLayoutPosition pageLayoutPosition = richEditControl1.ActiveView.GetDocumentLayoutPosition(e.Location);
    if (pageLayoutPosition == null)

VB.NET

layout-api-treeview-example-t239200/VB/LayoutApiSample/Form1.vb#L34

Private Sub richEditControl1_MouseMove(ByVal sender As Object, ByVal e As MouseEventArgs)
    Dim pos As PageLayoutPosition = richEditControl1.ActiveView.GetDocumentLayoutPosition(e.Location)
    If pos IsNot Nothing Then

how-to-insert-a-checkbox-into-a-richeditcontrol-document-t600135/VB/RichEditControl_CheckBox/Form1.vb#L32

Private Sub richEditControl1_MouseClick(ByVal sender As Object, ByVal e As MouseEventArgs) Handles richEditControl1.MouseClick
    Dim pageLayoutPosition As PageLayoutPosition = richEditControl1.ActiveView.GetDocumentLayoutPosition(e.Location)
    If pageLayoutPosition Is Nothing Then