officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-1f3b67f4.md
A position within a document.
Namespace : DevExpress.XtraRichEdit.API.Native
Assembly : DevExpress.RichEdit.v25.2.Core.dll
NuGet Package : DevExpress.RichEdit.Core
[ComVisible(true)]
public abstract class DocumentPosition :
IComparable<DocumentPosition>
<ComVisible(True)>
Public MustInherit Class DocumentPosition
Implements IComparable(Of DocumentPosition)
The following members return DocumentPosition objects:
| Library | Related API Members |
|---|---|
| WinForms Controls | RichEditControl.GetPositionFromPoint(PointF) |
| WPF Controls | RichEditControl.GetPositionFromPoint(PointF) |
| Office File API | Capture.Position |
| CustomMark.Position | |
| Document.CaretPosition | |
| DocumentRange.End | |
| DocumentRange.Start | |
| SubDocument.CreatePosition(Int32) |
Use the Document.CaretPosition property to get the current cursor (caret) position. The RichEditControl.GetPositionFromPoint method allows you to convert mouse coordinates to a document position.
The DocumentRange.Start and DocumentRange.End positions define a DocumentRange object.
Use the SubDocument.CreatePosition method to obtain an arbitrary position in a document. Call the DocumentPosition.ToInt method to convert a DocumentPosition object to an integer position.
The code sample below obtains a range that starts from the retrieved position:
Document document = server.Document;
document.LoadDocument("Documents\\Grimm.docx", DocumentFormat.Docx);
DocumentPosition myStart = document.CreatePosition(69);
DocumentRange myRange = document.CreateRange(myStart, 216);
Dim document As Document = server.Document
document.LoadDocument("Documents\Grimm.docx", DocumentFormat.Docx)
Dim myStart As DocumentPosition = document.CreatePosition(69)
Dim myRange As DocumentRange = document.CreateRange(myStart, 216)
Object DocumentPosition
See Also