BackgroundCalculation Property (IWorkbookSet)

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.

Syntax

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration
 
Property BackgroundCalculation As System.Boolean

'Usage
 
Dim instance As IWorkbookSet
Dim value As System.Boolean
 
instance.BackgroundCalculation = value
 
value = instance.BackgroundCalculation

System.bool BackgroundCalculation {get; set;}

read-write property BackgroundCalculation: System.Boolean;

function get,set BackgroundCalculation : System.boolean

__property System.bool get_BackgroundCalculation();
__property void set_BackgroundCalculation( 
   System.bool value
);

property System.bool BackgroundCalculation {
   System.bool get();
   void set (    System.bool value);
}

Remarks

This property is thread safe.

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

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

When utilizing background calculation, IWorkbookSet.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 IWorkbookSet.ReleaseLock whenever they access anything in a workbook set.

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

Requirements

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

Reference

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