DocumentPosition Class
A position within a document.
Namespace: DevExpress.XtraRichEdit.API.Native
Assembly: DevExpress.RichEdit.v24.2.Core.dll
NuGet Package: DevExpress.RichEdit.Core
#Declaration
#Related API Members
The following members return DocumentPosition objects:
Library | Related API Members |
---|---|
Win |
Rich |
WPF Controls | Rich |
Office File API | Capture. |
Custom |
|
Document. |
|
Document |
|
Document |
|
Sub |
#Remarks
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.OpenXml);
DocumentPosition myStart = document.CreatePosition(69);
DocumentRange myRange = document.CreateRange(myStart, 216);