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

C#

public abstract void EndUpdateDocument(
    SubDocument document
)

VB.NET

Public MustOverride Sub EndUpdateDocument(
    document As SubDocument
)

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.

Related GitHub Examples

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.

C#

winforms-richedit-document-api/CS/RichEditAPISample/CodeExamples/FormFields.cs#L24

checkBox.HelpText = "help text";
currentPosition.EndUpdateDocument(currentDocument);
#endregion #InsertCheckBox

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/RangeActions.cs#L25

doc.InsertText(pos, " INSERTED TEXT ");
pos.EndUpdateDocument(doc);
#endregion #InsertTextAtCaretPosition

winforms-richedit-layout-api-practical-usage/CS/WindowsFormsApplication1/DocumentLayoutHelper/RichEditDocumentLayoutAnalyzer.cs#L30

currentDocument.CaretPosition.EndUpdateDocument(subDocument);

winforms-richedit-layout-api/CS/LayoutApiSimpleExample/Form1.cs#L93

}
richEditControl1.Document.CaretPosition.EndUpdateDocument(subDoc);
#endregion #GetPageForPosition

word-document-api-examples/CS/CodeExamples/RangeActions.cs#L96

doc.InsertText(newPos, "<<Appended to Paragraph End>>");
pos.EndUpdateDocument(doc);
#endregion #AppendToParagraph

VB.NET

winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/FormFields.vb#L22

            checkBox.HelpText = "help text"
            currentPosition.EndUpdateDocument(currentDocument)
#End Region  ' #InsertCheckBox

wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/RangeActions.vb#L21

            doc.InsertText(pos, " INSERTED TEXT ")
            pos.EndUpdateDocument(doc)
'            #End Region ' #InsertTextAtCaretPosition

winforms-richedit-layout-api-practical-usage/VB/WindowsFormsApplication1/DocumentLayoutHelper/RichEditDocumentLayoutAnalyzer.vb#L35

currentDocument.CaretPosition.EndUpdateDocument(subDocument)

winforms-richedit-layout-api/VB/LayoutApiSimpleExample/Form1.vb#L76

            End If
            richEditControl1.Document.CaretPosition.EndUpdateDocument(subDoc)
'            #End Region ' #GetPageForPosition

word-document-api-examples/VB/CodeExamples/RangeActions.vb#L86

            doc.InsertText(newPos, "<<Appended to Paragraph End>>")
            pos.EndUpdateDocument(doc)
#End Region  ' #AppendToParagraph