SftBox/OCX 4.5

SftBox.BulkUpdate Property

Softel vdm, Inc.

Defines bulk update mode.

Syntax       

Get

VB.NET

Boolean = object.BulkUpdate  As Boolean

VB

Boolean = object.BulkUpdate  As Boolean

C#.NET

bool Boolean = object.BulkUpdate;

VC++

VARIANT_BOOL Boolean = object->BulkUpdate;
VARIANT_BOOL Boolean = object->GetBulkUpdate();

C

HRESULT object->get_BulkUpdate(VARIANT_BOOL* Boolean);

Delphi

Boolean := object.BulkUpdate   : WordBool;

Put

VB.NET

object.BulkUpdate = Boolean  As Boolean

VB

object.BulkUpdate = Boolean  As Boolean

C#.NET

bool object.BulkUpdate = Boolean;

VC++

VARIANT_BOOL object->BulkUpdate = Boolean;
void object->PutBulkUpdate(VARIANT_BOOL Boolean);

C

HRESULT object->put_BulkUpdate(VARIANT_BOOL Boolean);

Delphi

object.BulkUpdate := Boolean   : WordBool;

object

A SftBox object.

Boolean

Defines bulk update mode.

Boolean

Description

True

A mass-update is in progress.

False

A mass-update has ended.

Comments

The BulkUpdate property defines bulk update mode.

The BulkUpdate property should be used when many items are added to a control or other lengthy operations are performed. By setting the property to True, the control can skip certain internal processing. Once updates are completed, the property has to be set to False. When adding, inserting or deleting items or when changing the Item.Level property, the control may have to do an extensive scan of parent items to determine if the current (visual) presentation has to be changed. This processing can be skipped when the BulkUpdate property is set to True, considerably speeding up the process.

After updating the control, the BulkUpdate property must be set to False. If the property remains set to True, the control will no longer redraw itself properly. The property should be set to True once, before adding many items and later set to False once, after all items have been added. Repeatedly setting the property to True and False while adding items significantly decreases the control's performance.

This property is not available at design-time.


Feedback / comments / error reports for this topic
© 2008 - Softel vdm, Inc. - www.softelvdm.com