DocumentRange.EndUpdateDocument(SubDocument) Method

Finalizes modifications of the document obtained via the document’s range (e.g. via selection).

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

void EndUpdateDocument(
    SubDocument document
)

VB.NET

Sub EndUpdateDocument(
    document As SubDocument
)

Parameters

Name	Type	Description
document	SubDocument	A SubDocument instance obtained via the previously called DocumentRange.BeginUpdateDocument method.

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 EndUpdateDocument method implements this requirement.

Example

The following code replaces the selected text with asterisks.

The RichEditControl instance is passed to the BarItem.ItemClick event handler using the BarItem.Tag property.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-the-richeditcontrols-common-api-t210437

RichEditControlActions.vb

Private Shared Sub buttonCustomAction_ItemClick_Replace(ByVal sender As Object, ByVal e As ItemClickEventArgs)
    Dim richEdit As RichEditControl = TryCast(e.Item.Tag, RichEditControl)
    Dim range As DocumentRange = richEdit.Document.Selection
    Dim selLength As Integer = range.Length
    Dim s As New String("*"c, selLength)
    Dim doc As SubDocument = range.BeginUpdateDocument()
    doc.InsertSingleLineText(range.Start, s)
    Dim rangeToRemove As DocumentRange = doc.CreateRange(range.Start, selLength)
    doc.Delete(rangeToRemove)
    range.EndUpdateDocument(doc)
End Sub

RichEditControlActions.cs

static void buttonCustomAction_ItemClick_Replace(object sender, ItemClickEventArgs e) {
    RichEditControl richEdit = e.Item.Tag as RichEditControl;
    DocumentRange range = richEdit.Document.Selection;
    int selLength = range.Length;
    string s = new String('*', selLength);
    SubDocument doc = range.BeginUpdateDocument();
    doc.InsertSingleLineText(range.Start, s);
    DocumentRange rangeToRemove = doc.CreateRange(range.Start, selLength);
    doc.Delete(rangeToRemove);
    range.EndUpdateDocument(doc);
}

Related GitHub Examples

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

    mhtText = doc.GetMhtText(selection);
    selection.EndUpdateDocument(doc);
}

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

    DocumentRange range = doc.InsertSingleLineText(_cell.Range.Start, String.Format("{0}", _cell.Index +1));
    range.EndUpdateDocument(doc);
}

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

    doc.EndUpdateCharacters(cp);
    range.EndUpdateDocument(doc);
}

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

    sourceSelectedRange = subDocument.CreateRange(selection.Start, richEditControl.Document.Selection.Length);
    selection.EndUpdateDocument(subDocument);
}

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

string plainText = docRange.GetText(docRange.Range);
document.Selection.EndUpdateDocument(docRange);

VB.NET

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

    mhtText = doc.GetMhtText(selection)
    selection.EndUpdateDocument(doc)
Else

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

    Dim range As DocumentRange = doc.InsertSingleLineText(_cell.Range.Start, String.Format("{0}", _cell.Index +1))
    range.EndUpdateDocument(doc)
Next _cell

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

    doc.EndUpdateCharacters(cp)
    range.EndUpdateDocument(doc)
Next _cell

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

    sourceSelectedRange = subDocument.CreateRange(selection.Start, richEditControl.Document.Selection.Length)
    selection.EndUpdateDocument(subDocument)
End Sub

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

Dim plainText As String = docRange.GetText(docRange.Range)
document.Selection.EndUpdateDocument(docRange)