RichEditControl.Document Property

Provides access to a Document interface specifying the control’s document.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v18.2.dll

Declaration

C#

[Browsable(false)]
public Document Document { get; }

VB.NET

<Browsable(False)>
Public ReadOnly Property Document As Document

Property Value

Type	Description
Document	A Document interface specifying a document loaded in the control.

Remarks

The Document property is the main access point to the XtraRichEdit API.

Note

The Document property gives you access only to the main document body. In particular, it means that you cannot access field or bookmark collections located in the header/footer using this property, but only via the Section.BeginUpdateHeader - Section.EndUpdateHeader pair.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Document 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.

C#

how-to-save-the-text-of-a-document-range-in-different-formats-e1604/CS/GetTextMethodsExample/Form1.cs#L29

#region #exportmht
if (this.richEditControl.Document.Selection.Length > 0)
{

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

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

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

Document doc = richEditControl1.Document;
// Clear out the document content

how-to-insert-text-between-two-bookmarks-e4405/CS/CS/BookmarkInsertLR/Form1.cs#L20

richEditControl1.Options.Bookmarks.Visibility = DevExpress.XtraRichEdit.RichEditBookmarkVisibility.Visible;
Document document = richEditControl1.Document;
document.InsertText(document.CreatePosition(0), "Bookmark 1Bookmark 2Bookmark 3Bookmark 4");

how-to-use-document-variable-docvariable-fields-e3099/CS/DocumentVariablesExample/Form1.cs#L21

richEditControl1.Options.MailMerge.DataSource = new SampleData();
richEditControl2.Document.CalculateDocumentVariable += new CalculateDocumentVariableEventHandler(eventHandler_CalculateDocumentVariable);
this.richEdit = richEditControl1;

VB.NET

how-to-save-the-text-of-a-document-range-in-different-formats-e1604/VB/GetTextMethodsExample/Form1.vb#L26

Try
    If Me.richEditControl.Document.Selection.Length > 0 Then
        Dim selection As DevExpress.XtraRichEdit.API.Native.DocumentRange = richEditControl.Document.Selection

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

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

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

Dim doc As Document = richEditControl1.Document
' Clear out the document content

how-to-insert-text-between-two-bookmarks-e4405/VB/CS/BookmarkInsertLR/Form1.vb#L22

richEditControl1.Options.Bookmarks.Visibility = DevExpress.XtraRichEdit.RichEditBookmarkVisibility.Visible
Dim document As Document = richEditControl1.Document
document.InsertText(document.CreatePosition(0), "Bookmark 1Bookmark 2Bookmark 3Bookmark 4")

how-to-use-document-variable-docvariable-fields-e3099/VB/DocumentVariablesExample/Form1.vb#L23

richEditControl1.Options.MailMerge.DataSource = New SampleData()
AddHandler richEditControl2.Document.CalculateDocumentVariable, AddressOf eventHandler_CalculateDocumentVariable
Me.richEdit = richEditControl1