DocumentPosition Class

A position within a document.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.WindowsDesktop.RichEdit.Core

Declaration

C#

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

VB.NET

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

Related API Members

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)

Related API Members

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)

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:

C#

Document document = server.Document;
document.LoadDocument("Documents\\Grimm.docx", DocumentFormat.OpenXml);
DocumentPosition myStart = document.CreatePosition(69);
DocumentRange myRange = document.CreateRange(myStart, 216);

VB.NET

Dim document As Document = server.Document
document.LoadDocument("Documents\Grimm.docx", DocumentFormat.OpenXml)
Dim myStart As DocumentPosition = document.CreatePosition(69)
Dim myRange As DocumentRange = document.CreateRange(myStart, 216)

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DocumentPosition class.

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#

inline-pictures-in-richeditcontrol-e1525/CS/InlinePictures/Form1.cs#L27

DocumentPosition pos = richEditControl1.Document.CaretPosition;
Image imageToInsert = imageCollection1.Images[3];

how-to-retain-original-image-uri-in-html-document-e3189/CS/HTML_Export_ImageSourceExample/Form1.cs#L17

richEditControl1.CreateNewDocument();
DocumentPosition pos = richEditControl1.Document.CaretPosition;
richEditControl1.Document.Images.Insert(pos, DocumentImageSource.FromUri(imageUri, null));

table-api-creating-table-a-simple-example-e3242/CS/Walkthrough_Creating_Table/Form1.cs#L38

// Set up header information
DocumentPosition pos = doc.Range.Start;
DocumentRange rng = doc.InsertSingleLineText(pos, "Directory Information from C:\\");

VB.NET

inline-pictures-in-richeditcontrol-e1525/VB/InlinePictures/Form1.vb#L29

Dim pos As DocumentPosition = richEditControl1.Document.CaretPosition
Dim imageToInsert As Image = imageCollection1.Images(3)

how-to-retain-original-image-uri-in-html-document-e3189/VB/HTML_Export_ImageSourceExample/Form1.vb#L16

richEditControl1.CreateNewDocument()
Dim pos As DocumentPosition = richEditControl1.Document.CaretPosition
richEditControl1.Document.Images.Insert(pos, DocumentImageSource.FromUri(imageUri, Nothing))

table-api-creating-table-a-simple-example-e3242/VB/Walkthrough_Creating_Table/Form1.vb#L35

' Set up header information
Dim pos As DocumentPosition = doc.Range.Start
Dim rng As DocumentRange = doc.InsertSingleLineText(pos, "Directory Information from C:\")

Inheritance

Object

DocumentPosition