officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-document-f0eefe69.md
Gets or sets the position of the caret within the document.
Namespace : DevExpress.XtraRichEdit.API.Native
Assembly : DevExpress.RichEdit.v25.2.Core.dll
NuGet Package : DevExpress.RichEdit.Core
DocumentPosition CaretPosition { get; set; }
Property CaretPosition As DocumentPosition
| Type | Description |
|---|---|
| DocumentPosition |
A DocumentPosition object, representing the current caret position.
|
Use this property to insert text at the current cursor position or to access the paragraph where the cursor is located (the ReadOnlyParagraphCollection.Get method).
Note
When working with headers/footers, use the DocumentPosition.BeginUpdateDocument - DocumentPosition.EndUpdateDocument pair to get the correct position. Otherwise an InvalidOperationException is thrown.
The following code snippets (auto-collected from DevExpress Examples) contain references to the CaretPosition property.
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.
winforms-richedit-document-api/CS/RichEditAPISample/CodeExamples/Field.cs#L15
#region #InsertField
DocumentPosition caretPosition = document.CaretPosition;
wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/FormFieldsActions.cs#L15
#region #CreateCheckbox
DocumentPosition currentPosition = document.CaretPosition;
DevExpress.XtraRichEdit.API.Native.CheckBox checkBox = document.FormFields.InsertCheckBox(currentPosition);
winforms-richeditcontrol-common-api/CS/RichEditAPISample/CodeExamples/RichEditControlActions.cs#L100
richEdit.LoadDocument("Documents\\MultiPageDocument.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml);
richEdit.Document.CaretPosition = richEdit.Document.Range.End;
richEdit.ScrollToCaret();
winforms-richedit-perform-drag-and-drop-from-list-box/CS/Form1.cs#L49
richEditControl1.Document.CaretPosition = pos;
winforms-rich-text-editor-retain-original-image-uri-in-html-document/CS/Form1.cs#L18
richEditControl1.CreateNewDocument();
DocumentPosition pos = richEditControl1.Document.CaretPosition;
richEditControl1.Document.Images.Insert(pos, DocumentImageSource.FromUri(imageUri, null));
winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/Field.vb#L14
#Region "#InsertField"
Dim caretPosition As DevExpress.XtraRichEdit.API.Native.DocumentPosition = document.CaretPosition
'Start updating the document
wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/FormFieldsActions.vb#L12
' #Region "#CreateCheckbox"
Dim currentPosition As DocumentPosition = document.CaretPosition
Dim checkBox As DevExpress.XtraRichEdit.API.Native.CheckBox = document.FormFields.InsertCheckBox(currentPosition)
winforms-richeditcontrol-common-api/VB/RichEditAPISample/CodeExamples/RichEditControlActions.vb#L105
richEdit.LoadDocument("Documents\MultiPageDocument.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml)
richEdit.Document.CaretPosition = richEdit.Document.Range.End
richEdit.ScrollToCaret()
winforms-richedit-perform-drag-and-drop-from-list-box/VB/Form1.vb#L38
Dim rect As Rectangle = Units.DocumentsToPixels(richEditControl1.GetBoundsFromPosition(pos), richEditControl1.DpiX, richEditControl1.DpiY)
richEditControl1.Document.CaretPosition = pos
If richEditGraphics Is Nothing Then richEditGraphics = richEditControl1.CreateGraphics()
winforms-rich-text-editor-retain-original-image-uri-in-html-document/VB/Form1.vb#L14
richEditControl1.CreateNewDocument()
Dim pos As DocumentPosition = richEditControl1.Document.CaretPosition
richEditControl1.Document.Images.Insert(pos, DocumentImageSource.FromUri(imageUri, Nothing))
See Also