RichEditDocumentServer.EndUpdate() Method

Unlocks the RichEditDocumentServer object.

Namespace: DevExpress.XtraRichEdit

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

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

Declaration

C#

public void EndUpdate()

VB.NET

Public Sub

Remarks

Enclose your code in the BeginUpdate() - EndUpdate method calls to improve performance when you apply multiple modifications to a document.

Each call to BeginUpdate() must be paired with the EndUpdate call. You can use the try…finally statement to ensure that EndUpdate is always called even if an exception occurs.

The following example shows how to use the BeginUpdate() - EndUpdate methods.

C#

// Create a new RichEditDocumentServer instance.
RichEditDocumentServer richEditDocumentServer = new RichEditDocumentServer();

richEditDocumentServer.BeginUpdate();
try
{
    // Create a multiplication table.
    Table table = richEditDocumentServer.Document.Tables.Create(richEditDocumentServer.Document.Selection.Start, 8, 8, AutoFitBehaviorType.AutoFitToWindow);

    table.Borders.InsideHorizontalBorder.LineThickness = 1;
    table.Borders.InsideHorizontalBorder.LineStyle = TableBorderLineStyle.Double;
    table.Borders.InsideVerticalBorder.LineThickness = 1;
    table.Borders.InsideVerticalBorder.LineStyle = TableBorderLineStyle.Double;
    table.TableAlignment = TableRowAlignment.Center;

    table.ForEachCell((cell, rowIndex, columnIndex) =>
    {
        richEditDocumentServer.Document.InsertText(cell.Range.Start, String.Format("{0}*{1} = {2}",
             columnIndex + 2, rowIndex + 2, (rowIndex + 2) * (columnIndex + 2)));
    });

}
finally
{
    richEditDocumentServer.EndUpdate();
}

VB.NET

' Create a new RichEditDocumentServer instance.
Dim richEditDocumentServer As New RichEditDocumentServer()

richEditDocumentServer.BeginUpdate()
Try
    ' Create a multiplication table.
    Dim table As Table = richEditDocumentServer.Document.Tables.Create(richEditDocumentServer.Document.Selection.Start, 8, 8, AutoFitBehaviorType.AutoFitToWindow)

    table.Borders.InsideHorizontalBorder.LineThickness = 1
    table.Borders.InsideHorizontalBorder.LineStyle = TableBorderLineStyle.Double
    table.Borders.InsideVerticalBorder.LineThickness = 1
    table.Borders.InsideVerticalBorder.LineStyle = TableBorderLineStyle.Double
    table.TableAlignment = TableRowAlignment.Center

    table.ForEachCell(Sub(cell, rowIndex, columnIndex)
                           richServer.Document.InsertText(cell.Range.Start, String.Format("{0}*{1} is {2}",
                                                        columnIndex + 2, rowIndex + 2, (rowIndex + 2) * (columnIndex + 2)))
                       End Sub)

Finally
    richEditDocumentServer.EndUpdate()
End Try

Related GitHub Examples

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

word-document-api-examples/CS/CodeExamples/BookmarksAndHyperlinks.cs#L25

document.Hyperlinks[0].Anchor = "Top";
wordProcessor.EndUpdate();
#endregion #InsertBookmark

word-document-api-use-printablecomponentlink-to-print-document/CS/PrintingSystem/Form1.cs#L30

SetPrintOptions(srv);
srv.EndUpdate();
// Display field values instead of code.

VB.NET

word-document-api-invoke-print-preview-dialog/VB/RichEditDocumentServer-Printing/Form1.vb#L43

_table.EndUpdate()
richServer.EndUpdate()
' Invoke the Print Preview dialog

word-document-api-examples/VB/CodeExamples/BookmarksAndHyperlinks.vb#L24

            document.Hyperlinks(CInt((0))).Anchor = "Top"
            wordProcessor.EndUpdate()
#End Region  ' #InsertBookmark

word-document-api-use-printablecomponentlink-to-print-document/VB/PrintingSystem/Form1.vb#L30

SetPrintOptions(srv)
srv.EndUpdate()
' Display field values instead of code.