DocumentLayout.BeginUpdateDocument(RangedLayoutElement) Method

Starts modifying the document obtained via a layout element.

Namespace: DevExpress.XtraRichEdit.API.Layout

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

public SubDocument BeginUpdateDocument(
    RangedLayoutElement element
)

VB.NET

Public Function BeginUpdateDocument(
    element As RangedLayoutElement
) As SubDocument

Parameters

Name	Type	Description
element	RangedLayoutElement	A RangedLayoutElement object that is the layout element which has a related DocumentRange.

Returns

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

Remarks

Use the DocumentLayout.BeginUpdateDocument - DocumentLayout.EndUpdateDocumentpair to modify the document obtained via a layout element implementing the RangedLayoutElement interface. In that case, it is very important to distinguish different parts of the document, such as header, footer and body. The BeginUpdateDocument method implements this requirement.

Related GitHub Examples

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

SubDocument doc = currentLayout.BeginUpdateDocument(currentTextBox);
string plainTextContent = doc.GetText(doc.Range);

VB.NET

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

Dim doc As SubDocument = currentLayout.BeginUpdateDocument(currentTextBox)
Dim plainTextContent As String = doc.GetText(doc.Range)