RichEditControl.BeginUpdate() Method

Locks the RichEditControl to prevent its visual updates until the RichEditControl.EndUpdate method is called.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v24.2.dll

Declaration

C#

public void BeginUpdate()

VB.NET

Public Sub BeginUpdate

Remarks

Enclose your code in the BeginUpdate - RichEditControl.EndUpdate method calls to suppress the RichEditControl’s visual updates and improve its performance when you perform multiple changes to a document.

Each call to BeginUpdate must be paired with the RichEditControl.EndUpdate call. The BeginUpdate method locks the RichEditControl, so that it is not rendered after each modification. The RichEditControl.EndUpdate method unlocks the control to enable all the changes to take effect. You can use the try…finally statement to ensure that RichEditControl.EndUpdate is always called even if an exception occurs.

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

C#

richEditControl1.BeginUpdate();
try
{
    Document document = richEditControl1.Document;

    // Create a multiplication table.
    Table table = document.Tables.Create(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) =>
    {
        document.InsertText(cell.Range.Start, String.Format("{0}*{1} = {2}",
             columnIndex + 2, rowIndex + 2, (rowIndex + 2) * (columnIndex + 2)));
    });

}
finally
{
    richEditControl1.EndUpdate();
}

VB.NET

richEditControl1.BeginUpdate()
Try
    Dim document As Document = richEditControl1.Document

    ' Create a multiplication table.
    Dim table As Table = document.Tables.Create(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) document.InsertText(cell.Range.Start, String.Format("{0}*{1} = {2}", columnIndex + 2, rowIndex + 2, (rowIndex + 2) * (columnIndex + 2))))

Finally
    richEditControl1.EndUpdate()
End Try

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the BeginUpdate() 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-remove-an-empty-paragraph-when-appending-a-content/CS/Form1.cs#L17

private void button1_Click(object sender, EventArgs e) {
    richEditControl1.BeginUpdate();
    RemoveParFromSourceRtf();

how-to-replace-document-fields-with-their-values/CS/Form1.cs#L37

private void FieldsToValues(RichEditControl control) {
    control.BeginUpdate();
    try {

winforms-rich-edit-implement-ms-office-word-format-painter/CS/DXApplication9/Form1.cs#L105

richEditControl.BeginUpdate();
SubDocument targetSubDocument = targetSelectedRange.BeginUpdateDocument();

VB.NET

winforms-richedit-remove-an-empty-paragraph-when-appending-a-content/VB/Form1.vb#L19

Private Sub button1_Click(ByVal sender As Object, ByVal e As EventArgs)
    richEditControl1.BeginUpdate()
    RemoveParFromSourceRtf()

how-to-replace-document-fields-with-their-values/VB/Form1.vb#L36

Private Sub FieldsToValues(ByVal control As RichEditControl)
    control.BeginUpdate()
    Try

winforms-spreadsheet-how-to-edit-rich-text/VB/SpreadsheetRichText/RichTextEditForm.vb#L13

Private Sub InitRichEditControl()
    RichEditControl1.BeginUpdate()
    If cell.HasRichText Then

winforms-rich-edit-implement-ms-office-word-format-painter/VB/DXApplication9/Form1.vb#L94

richEditControl.BeginUpdate()
Dim targetSubDocument As SubDocument = targetSelectedRange.BeginUpdateDocument()