DocumentLayout.EndUpdateDocument(SubDocument) Method

Finalizes modifications of the document obtained via the layout element.

Namespace: DevExpress.XtraRichEdit.API.Layout

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

public void EndUpdateDocument(
    SubDocument document
)

VB.NET

Public Sub EndUpdateDocument(
    document As SubDocument
)

Parameters

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

Remarks

Use the DocumentLayout.BeginUpdateDocument - DocumentLayout.EndUpdateDocument pair to modify the document obtained via the layout element implementing the RangedLayoutElement interface, such as comment, textBox, header, footer and page.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference 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#

winforms-richedit-layout-api-practical-usage/CS/WindowsFormsApplication1/DocumentLayoutHelper/TextBoxLayoutHelper.cs#L56

string plainTextContent = doc.GetText(doc.Range);
currentLayout.EndUpdateDocument(doc);

VB.NET

winforms-richedit-layout-api-practical-usage/VB/WindowsFormsApplication1/DocumentLayoutHelper/TextBoxLayoutHelper.vb#L61

Dim plainTextContent As String = doc.GetText(doc.Range)
currentLayout.EndUpdateDocument(doc)