DocumentPosition.BeginUpdateDocument() Method

Starts modifying the document obtained via the document’s position (e.g. via the caret position).

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

public abstract SubDocument BeginUpdateDocument()

VB.NET

Public MustOverride Function BeginUpdateDocument As SubDocument

Returns

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

Remarks

Use the DocumentPosition.BeginUpdateDocument - DocumentPosition.EndUpdateDocument pair to modify the document obtained via its position in that document (i.e. by using the Document.CaretPosition 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.

Note

If the location of the obtained document position is ambiguous (it may belong to either header, footer or body of the document), use the BeginUpdateDocument to perform modifications. Otherwise, an exception may occur.

Example

The following code snippet demonstrates how you can insert text at the cursor position in the RichEditControl document:

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-richedit-document-api-e5219

Range.vb

Dim pos As DocumentPosition = document.CaretPosition
Dim doc As SubDocument = pos.BeginUpdateDocument()
doc.InsertText(pos, " INSERTED TEXT ")
pos.EndUpdateDocument(doc)

Range.cs

DocumentPosition pos = document.CaretPosition;
SubDocument doc = pos.BeginUpdateDocument();
doc.InsertText(pos, " INSERTED TEXT ");
pos.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#

winforms-richedit-document-api-e5219/CS/RichEditAPISample/CodeExamples/FormFields.cs#L17

DocumentPosition currentPosition = document.CaretPosition;
SubDocument currentDocument = currentPosition.BeginUpdateDocument();
DevExpress.XtraRichEdit.API.Native.CheckBox checkBox = document.FormFields.InsertCheckBox(currentPosition);

subdocument-essentials-simple-examples-e2265/CS/SubDocumentExample/Form1.cs#L29

DocumentPosition pos = richEditControl1.Document.CaretPosition;
SubDocument doc = pos.BeginUpdateDocument();
doc.InsertText(pos, " INSERTED TEXT ");

how-to-insert-a-checkbox-into-a-richeditcontrol-document-t600135/CS/RichEditControl_CheckBox/Form1.cs#L26

DocumentPosition caretPosition = richEditControl1.Document.CaretPosition;
SubDocument document = caretPosition.BeginUpdateDocument();
DocumentRange checkBox = document.InsertText(caretPosition, uncheckedCheckBox);

wpf-richedit-document-api-t213968/CS/DXRichEditControlAPISample/CodeExamples/RangeActions.cs#L23

DocumentPosition pos = document.CaretPosition;
SubDocument doc = pos.BeginUpdateDocument();
doc.InsertText(pos, " INSERTED TEXT ");

word-document-api-examples/CS/CodeExamples/RangeActions.cs#L29

DocumentPosition pos = document.CaretPosition;
SubDocument doc = pos.BeginUpdateDocument();
doc.InsertText(pos, " INSERTED TEXT ");

VB.NET

winforms-richedit-document-api-e5219/VB/RichEditAPISample/CodeExamples/Field.vb#L15

'Start updating the document
caretPosition.BeginUpdateDocument()

wpf-richedit-document-api-t213968/VB/DXRichEditControlAPISample/CodeExamples/DocumentFieldActions.vb#L22

Dim caretPosition As DocumentPosition = document.CaretPosition
Dim currentDocument As SubDocument = caretPosition.BeginUpdateDocument()

subdocument-essentials-simple-examples-e2265/VB/SubDocumentExample/Form1.vb#L27

Dim pos As DocumentPosition = richEditControl1.Document.CaretPosition
Dim doc As SubDocument = pos.BeginUpdateDocument()
doc.InsertText(pos, " INSERTED TEXT ")

how-to-insert-a-checkbox-into-a-richeditcontrol-document-t600135/VB/RichEditControl_CheckBox/Form1.vb#L24

Dim caretPosition As DocumentPosition = richEditControl1.Document.CaretPosition
Dim document As SubDocument = caretPosition.BeginUpdateDocument()
Dim checkBox As DocumentRange = document.InsertText(caretPosition, uncheckedCheckBox)

word-document-api-examples/VB/CodeExamples/RangeActions.vb#L25

Dim pos As DocumentPosition = document.CaretPosition
Dim doc As SubDocument = pos.BeginUpdateDocument()
doc.InsertText(pos, " INSERTED TEXT ")