SpreadsheetGear 2023
BackgroundCalculation Property (IWorkbookSet)

SpreadsheetGear Namespace > IWorkbookSet Interface : BackgroundCalculation Property
Gets or sets the property which specifies whether interruptible background calculation will be initiated as needed when the last lock on a workbook set is released.
Property BackgroundCalculation As System.Boolean
Dim instance As IWorkbookSet
Dim value As System.Boolean
instance.BackgroundCalculation = value
value = instance.BackgroundCalculation
System.bool BackgroundCalculation {get; set;}

This property is thread safe.

Changing BackgroundCalculation from true to false stops background calculation before the property setter returns.

BackgroundCalculation is on by default. However, background calculation will not be initiated if Calculation is set to Calculation.Manual or if a lock is never acquired and subsequently released.

When utilizing background calculation, GetLock must be used to acquire a lock before any access to any object in a workbook set.

All Windows Forms components from SpreadsheetGear use GetLock and ReleaseLock whenever they access anything in a workbook set.

See GetLock and ReleaseLock for more information about acquiring and releasing locks as well as the effect this has on background calculation.


Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also


IWorkbookSet Interface
IWorkbookSet Members
BackgroundCalculation Property
Calculation Property
CalculationOnDemand Property
Calculate Method
CalculateFull Method
CalculateFullRebuild Method
GetLock Method
ReleaseLock Method