EndCalculate Event (IWorkbookSet)

Occurs when calculation of this workbook set has completed. See remarks for information about the calling thread.

Syntax

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

'Declaration
 
Event EndCalculate As EndCalculateEventHandler

'Usage
 
Dim instance As IWorkbookSet
Dim handler As EndCalculateEventHandler
 
AddHandler instance.EndCalculate, handler

event EndCalculateEventHandler EndCalculate

event EndCalculate: EndCalculateEventHandler;

In JScript, you can handle the events defined by another class, but you cannot define your own.

__event EndCalculateEventHandler* EndCalculate

event EndCalculateEventHandler^ EndCalculate

Event Data

The event handler receives an argument of type EndCalculateEventArgs containing data related to this event. The following EndCalculateEventArgs properties provide information specific to this event.

Property	Description
BackgroundCalculation	Returns true if the EndCalculate event is being invoked on the background calculation thread, or false if it is being invoked on any other thread.

Remarks

This event occurs when calculation of this workbook set has completed.

This event is always invoked on the thread which completes calculation of the workbook set:

If calculation completes during execution of an API such as Save which may require calculation to be completed, the locked state of the workbook set will be the same as when the API was called.
If calculation completes during background calculation, the invoking thread is the background calculation thread and the workbook set will be locked before this event is invoked.

This event will not occur until calculation is complete. For example, this event will not occur if a partial calculation is completed in response to getting the value of a cell, and it will not be invoked if background calculation is interrupted.

The WorkbookView.Calculate event is always invoked on the thread which created the WorkbookView control and is generally a better choice when using the WorkbookView control.

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
EndCalculateEventArgs Class
BackgroundCalculation Property