Skip to main content

DocumentPosition.EndUpdateDocument(SubDocument) Method

Finalizes modifications performed for the document obtained via the document’s position (e.g. via the caret position).

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

public abstract void EndUpdateDocument(
    SubDocument document
)

Parameters

Name Type Description
document SubDocument

A SubDocument instance obtained via the previously called DocumentPosition.BeginUpdateDocument method.

Remarks

Use the DocumentPosition.BeginUpdateDocument - DocumentPosition.EndUpdateDocument pair to modify the document obtained via the 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 EndUpdateDocument 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 EndUpdateDocument to perform modifications. Otherwise an exception may occur.

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.

See Also