Document Interface

An interface that exposes the specific functionality of the document.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v21.1.Core.dll

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

[ComVisible(true)]
public interface Document :
    SubDocument

VB.NET

<ComVisible(True)>
Public Interface Document
    Inherits SubDocument

Related API Members

The following members return Document objects:

Show 11 links

Library	Related API Members
WinForms Controls	RichEditControl.Document
WPF Controls	RichEditControl.Document
Office File API	IRichEditControl.Document
	IRichEditDocumentServer.Document
	MailMergeFinishedEventArgs.Document
	MailMergeRecordFinishedEventArgs.Document
	MailMergeRecordFinishedEventArgs.RecordDocument
	MailMergeRecordStartedEventArgs.Document
	MailMergeRecordStartedEventArgs.RecordDocument
	MailMergeStartedEventArgs.Document
	RichEditDocumentServer.Document

Related API Members

The following members return Document objects:

Show 11 links

Library	Related API Members
WinForms Controls	RichEditControl.Document
WPF Controls	RichEditControl.Document
Office File API	IRichEditControl.Document
	IRichEditDocumentServer.Document
	MailMergeFinishedEventArgs.Document
	MailMergeRecordFinishedEventArgs.Document
	MailMergeRecordFinishedEventArgs.RecordDocument
	MailMergeRecordStartedEventArgs.Document
	MailMergeRecordStartedEventArgs.RecordDocument
	MailMergeStartedEventArgs.Document
	RichEditDocumentServer.Document

Remarks

While the SubDocument exposes the basic functionality of the document (formatting, text operations), the Document interface is responsible for more specific operations. Such a differentiation allows for proper handling of actions performed in the header/footer sections of the document.

The Document class exposes several properties and methods that allow you to specify units of measurement (Document.Unit), access its contents (Document.Sections and SubDocument.Paragraphs), and programmatically perform the most popular edit actions (Document.Copy, Document.Paste, Document.Cut, SubDocument.Delete, SubDocument.InsertText), as well as export and import its RTF contents (Document.SaveDocument and Document.LoadDocument).

Related GitHub Examples

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

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#

table-api-how-to-create-a-multiplication-table-in-code-e3231/CS/Table_API_Example/Form1.cs#L29

Document doc = richEditControl1.Document;
doc.BeginUpdate();

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-set-tab-stops-so-that-each-tab-is-of-certain-characters-width-e3198/CS/TabStop_EachNCharacters/Form1.cs#L30

#region #measuresinglelinestring
Document document = richEditControl1.Document;
SizeF tabSize = richEditControl1.MeasureSingleLineString(new String(' ', 4), document.DefaultCharacterProperties);

using-the-search-and-replace-api-functionality-e1677/CS/SearchAndReplaceExample/Form1.cs#L26

ISearchResult searchResult;
Document Document { get { return this.richEditControl1.Document; } }
SearchDirection direction = SearchDirection.Forward;

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

private void btn_ShowCodes_Click(object sender, EventArgs e) {
    Document doc = richEdit.Document;
    bool showCodes = btn_ShowCodes.Checked;

VB.NET

table-api-how-to-create-a-multiplication-table-in-code-e3231/VB/Table_API_Example/Form1.vb#L27

Dim doc As Document = richEditControl1.Document
doc.BeginUpdate()

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-set-tab-stops-so-that-each-tab-is-of-certain-characters-width-e3198/VB/TabStop_EachNCharacters/Form1.vb#L28

'            #Region "#measuresinglelinestring"
            Dim document As Document = richEditControl1.Document
            Dim tabSize As SizeF = richEditControl1.MeasureSingleLineString(New String(" "c, 4), document.DefaultCharacterProperties)

using-the-search-and-replace-api-functionality-e1677/VB/SearchAndReplaceExample/Form1.vb#L28

Private searchResult_Renamed As ISearchResult
Private ReadOnly Property Document() As Document
    Get

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

Private Sub btn_ShowCodes_Click(ByVal sender As Object, ByVal e As EventArgs) Handles btn_ShowCodes.CheckedChanged
    Dim doc As Document = richEdit.Document
    Dim showCodes As Boolean = btn_ShowCodes.Checked