Table.BeginUpdate() Method

Locks the Table object. Prevents visual updates until the EndUpdate method calls.

Namespace: DevExpress.XtraRichEdit.API.Native

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

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

Declaration

C#

void BeginUpdate()

VB.NET

Sub BeginUpdate

Remarks

Use the BeginUpdate and EndUpdate methods to avoid flickering during batch modifications to the Table‘s settings. After calling BeginUpdate, any changes to the Table‘s settings do not cause immediate repainting. This allows multiple changes without affecting performance or causing screen flickering. Once you finish all desired changes, call EndUpdate.

The BeginUpdate and EndUpdate methods use an internal counter to manage updates. The counter starts at 0. When the counter is above 0, the system blocks visual updates. When the counter returns to 0, the system allows updates. The BeginUpdate method increments the counter. The EndUpdate method decrements the counter. If the counter reaches 0, an immediate visual update occurs.

Always pair each BeginUpdate call with an EndUpdate call. To ensure EndUpdate runs even if an exception occurs, use the try...finally statement.

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#

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/TableActions.cs#L28

{
    tbl.BeginUpdate();
    foreach (FileInfo fi in dirinfo.GetFiles())

winforms-richedit-tables-simple-example/CS/TablesSimpleExample/Form1.cs#L51

{
    table.BeginUpdate();

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

{
    tbl.BeginUpdate();
    foreach (FileInfo fi in dirinfo.GetFiles())

word-document-api-examples/CS/CodeExamples/TablesActions.cs#L115

// Start to modify the table.
table.BeginUpdate();

word-document-api-table-examples/CS/TablesSimpleExample/Program.cs#L65

Table table = document.Tables[0];
table.BeginUpdate();

VB.NET

wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/TableActions.vb#L24

Try
    tbl.BeginUpdate()
    For Each fi As FileInfo In dirinfo.GetFiles()

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

Try
    tbl.BeginUpdate()
    For Each fi As System.IO.FileInfo In dirinfo.GetFiles()

word-document-api-examples/VB/CodeExamples/TablesActions.vb#L48

' Start to modify the table.
tbl.BeginUpdate()
' Obtain the file list from the specified directory

winforms-richedit-tables-simple-example/VB/TablesSimpleExample/Form1.vb#L27

Dim table As Table = document.Tables(0)
table.BeginUpdate()
' Repeat first three rows as header:

word-document-api-table-examples/VB/TablesSimpleExample/Program.vb#L54

Dim table As Table = document.Tables(0)
table.BeginUpdate()
'Split cell into 8