DocumentRange.BeginUpdateDocument() Method

Starts modifying the document obtained via the document’s range (e.g. via selection).

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v18.2.Core.dll

Declaration

C#

SubDocument BeginUpdateDocument()

VB.NET

Function BeginUpdateDocument As SubDocument

Returns

Type	Description
SubDocument	A SubDocument instance allowing you to safely modify the document.

Remarks

Use the DocumentRange.BeginUpdateDocument - DocumentRange.EndUpdateDocument pair to modify the document obtained via selection (i.e. by using the Document.Selection property). In that case, it is very important to distinguish different parts of the document, such as header, footer or body. The BeginUpdateDocument method implements this requirement.

Example

This code sample demonstrates how to use and modify the selected part of the document. The selection can be located in the main part of the document, within the table, in the header, footer or in a text box. The DocumentRange.BeginUpdateDocument method is a versatile method for accessing any document range, irrespective of its location. You are advised to obtain the selection using the Document.Selection property and use the SubDocument methods within the DocumentRange.BeginUpdateDocument - DocumentRange.EndUpdateDocument method pair.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/subdocument-essentials-simple-examples-e2265

Form1.cs

DocumentRange range = richEditControl1.Document.Selection;
SubDocument doc = range.BeginUpdateDocument();
string plainText = doc.GetText(range);
MessageBox.Show(plainText, "Selected Text");
doc.InsertText(range.Start,"->");
doc.InsertText(range.End, "<-");
range.EndUpdateDocument(doc);

Form1.vb

Dim range As DocumentRange = richEditControl1.Document.Selection
Dim doc As SubDocument = range.BeginUpdateDocument()
Dim plainText As String = doc.GetText(range)
MessageBox.Show(plainText, "Selected Text")
doc.InsertText(range.Start,"->")
doc.InsertText(range.End, "<-")
range.EndUpdateDocument(doc)

Related GitHub Examples

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

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));

dxrichedit-for-wpf-table-api-how-to-create-a-multiplication-table-in-code-e3296/CS/MainWindow.xaml.cs#L122

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

how-to-implement-the-basic-idea-of-the-ms-office-word-format-painter-for-richeditcontrol-e5223/CS/DXApplication9/Form1.cs#L85

DocumentRange selection = richEditControl.Document.Selection;
SubDocument subDocument = selection.BeginUpdateDocument();
sourceSelectedRange = subDocument.CreateRange(selection.Start, richEditControl.Document.Selection.Length);

winforms-richedit-document-api-e5219/CS/RichEditAPISample/CodeExamples/Export.cs#L64

// Get selection as plain text.
SubDocument docRange = document.Selection.BeginUpdateDocument();
string plainText = docRange.GetText(docRange.Range);

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))

dxrichedit-for-wpf-table-api-how-to-create-a-multiplication-table-in-code-e3296/VB/MainWindow.xaml.vb#L124

_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))

how-to-implement-the-basic-idea-of-the-ms-office-word-format-painter-for-richeditcontrol-e5223/VB/DXApplication9/Form1.vb#L77

Dim selection As DocumentRange = richEditControl.Document.Selection
Dim subDocument As SubDocument = selection.BeginUpdateDocument()
sourceSelectedRange = subDocument.CreateRange(selection.Start, richEditControl.Document.Selection.Length)

winforms-richedit-document-api-e5219/VB/RichEditAPISample/CodeExamples/Export.vb#L58

' Get selection as plain text.
Dim docRange As SubDocument = document.Selection.BeginUpdateDocument()
Dim plainText As String = docRange.GetText(docRange.Range)