BaseComponent.BeginUpdate() Method

Locks the BaseComponent, preventing visual updates of the object and its elements until the EndUpdate or CancelUpdate method is called.

Namespace: DevExpress.XtraBars.Docking2010.Base

Assembly: DevExpress.XtraBars.v19.2.dll

Declaration

C#

public void BeginUpdate()

VB.NET

Public Sub BeginUpdate

Remarks

Once the BeginUpdate method has been called, modifying the BaseComponent and its elements does not result in immediate visual updates. So, multiple modifications can be made to the BaseComponent object and its elements without a major impact on performance or screen flickering. After all the desired operations have been finished, call the EndUpdate or CancelUpdate method. Use the EndUpdate method to immediately perform a visual update, reflecting all the changes made. If no immediate visual update is required (for example, if no visual setting has been affected by the operations performed), call the CancelUpdate method.

The BeginUpdate, EndUpdate and CancelUpdate methods use an internal counter to implement the update functionality. The counter’s initial value is 0. The BeginUpdate method increments the counter. The EndUpdate and CancelUpdate decrement the counter.

The object’s visual updates (change notifications) are forbidden if the counter’s value is greater than 0, and the updates are enabled if the counter’s value is 0.

Each call to BeginUpdate must be paired with a call to EndUpdate or CancelUpdate. To ensure that EndUpdate/CancelUpdate is always called 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#

how-to-add-a-control-based-document-e3912/CS/DcoumentManagerContentGenerator/Form1.cs#L32

newTB.Text = s + " " + index.ToString();
documentManager2.View.BeginUpdate();
if (tabbed == true) {

tabbedview-how-to-convert-the-default-layout-to-a-table-one-t323423/CS/FreeLayoutModeExample/LayoutConverterHelper.cs#L22

TabbedView.BeginUpdate();
ClearGroups();

VB.NET

how-to-add-a-control-based-document-e3912/VB/DcoumentManagerContentGenerator/Form1.vb#L34

newTB.Text = s & " " & index.ToString()
documentManager2.View.BeginUpdate()
If tabbed = True Then

tabbedview-how-to-convert-the-default-layout-to-a-table-one-t323423/VB/FreeLayoutModeExample/LayoutConverterHelper.vb#L20

TabbedView.BeginUpdate()
ClearGroups()