SubDocument Interface

Exposes properties and methods representing essential document functionality.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

[ComVisible(true)]
public interface SubDocument

VB.NET

<ComVisible(True)>
Public Interface SubDocument

Related API Members

The following members return SubDocument objects:

• Comment.BeginUpdate()
• DocumentLayout.BeginUpdateDocument(RangedLayoutElement)
• DocumentPosition.BeginUpdateDocument()
• DocumentRange.BeginUpdateDocument()
• Section.BeginUpdateFooter()
• Section.BeginUpdateFooter(HeaderFooterType)
• Section.BeginUpdateHeader()
• Section.BeginUpdateHeader(HeaderFooterType)
• TextBox.Document

Remarks

The SubDocument interface delivers the basic document functionality that is common for the header, footer and the main document body. Specific functionality belongs to the Document interface.

To modify a document obtained via selection or the caret position, use the DocumentRange.BeginUpdateDocument or the DocumentPosition.BeginUpdateDocument methods, returning the SubDocument interface. Make sure to properly finalize modifications, by calling the corresponding EndUpdateDocument methods.

Related GitHub Examples

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

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

DevExpress.XtraRichEdit.API.Native.DocumentRange selection = richEditControl.Document.Selection;
DevExpress.XtraRichEdit.API.Native.SubDocument doc = selection.BeginUpdateDocument();
mhtText = doc.GetMhtText(selection);

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

_cell.BackgroundColor = Color.Empty;
SubDocument doc = _cell.Range.BeginUpdateDocument();
DocumentRange range = doc.InsertSingleLineText(_cell.Range.Start, String.Format("{0}", _cell.Index +1));

VB.NET

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

Dim selection As DevExpress.XtraRichEdit.API.Native.DocumentRange = richEditControl.Document.Selection
Dim doc As DevExpress.XtraRichEdit.API.Native.SubDocument = selection.BeginUpdateDocument()
mhtText = doc.GetMhtText(selection)

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

_cell.BackgroundColor = Color.Empty
Dim doc As SubDocument = _cell.Range.BeginUpdateDocument()
Dim range As DocumentRange = doc.InsertSingleLineText(_cell.Range.Start, String.Format("{0}", _cell.Index +1))