.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

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.v20.2.Core.dll

Declaration

public PageLayoutPosition GetDocumentLayoutPosition(
    Point point
)
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.

Examples

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.

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 = "";
}
See Also