.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
Box

DocumentLayout.BeginUpdateDocument(RangedLayoutElement) Method

Starts modifying the document obtained via a layout element.

Namespace: DevExpress.XtraRichEdit.API.Layout

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

Declaration

public SubDocument BeginUpdateDocument(
    RangedLayoutElement element
)

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.

The following code snippets (auto-collected from DevExpress Examples) contain references 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.

See Also