XLL+ Class Library (6.3)

CXllApp::WorkbookBeforeCloseEvent

Gets a reference to the WorkbookBeforeClose event

CXlWorkbookBeforeCloseEvent& WorkbookBeforeCloseEvent( );

Return Value

The function returns a reference to the application's WorkbookBeforeClose event, which is of type CXlWorkbookBeforeCloseEvent.

Remarks

The WorkbookBeforeClose event is raised when a workbook is about to be closed, and allows the event to be cancelled. All registered observers receive the event via the CXlEventObserver::Update method.

When observers are notified, an argument of type CXlBeforeCloseEventArgs is passed. Observers can cancel normal processing of the double-click by cancelling the event using CXlBeforeCloseEventArgs::SetCancel(false).

Registration

Observers can register for this event at any point in the life of the XLL. Registration can be done explicitly using Register, or automatically by creating an instance of CXlWorkbookBeforeCloseEventStaticObserver.

Requirements

Header: xllplus.h

See Also

CXllApp Class | CXllApp Methods | Events