DocumentPosition.BeginUpdateDocument() Method

Starts modifying the document obtained via the document's position (e.g. via the caret position).

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

public abstract SubDocument BeginUpdateDocument()

VB.NET

Public MustOverride Function BeginUpdateDocument As SubDocument

Returns

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

Remarks

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