DocumentPosition Class

Represents a position within a document.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v14.2.Core.dll

Declaration

C#

[ComVisible(true)]
public abstract class DocumentPosition :
    IComparable<DocumentPosition>

VB.NET

<ComVisible(True)>
Public MustInherit Class DocumentPosition
    Implements IComparable(Of DocumentPosition)

Returned By

Properties and methods that return DocumentPosition instances:

• Capture.Position
• CustomMark.Position
• Document.CaretPosition
• DocumentRange.End
• DocumentRange.Start
• RichEditControl.GetPositionFromPoint(PointF)
• SubDocument.CreatePosition(Int32)

Remarks

To get the current positon of a text cursor (caret) in a document, use the Document.CaretPosition property. To convert mouse coordinates to a document position, the RichEditControl.GetPositionFromPoint method is provided.

A DocumentRange object is defined by its DocumentRange.Start and DocumentRange.End positions.

Use the SubDocument.CreatePosition method to obtain an arbitrary position in a document. To convert a DocumentPosition object to an integer position, call the DocumentPosition.ToInt method.

Inheritance

Object

DocumentPosition