DocumentPosition Class

A position within a document.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v18.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)

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

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.

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

SnapDocumentPosition