XLL+ Class Library (6.3)

CXllApp::OnWorkbookBeforeClose

Called by the framework just before a workbook is closed

virtual BOOL OnWorkbookBeforeClose(
   LPDISPATCH dispWorkbook
);

Parameters

dispWorkbook

Pointer to dispatch interface of type Excel.Workbook.

Return Value

The function should return TRUE to cancel any further processing of the double-click event. It should return FALSE (the default) to enable normal processing to continue.

Note that if you return TRUE, the file will not be closed, and if the application is in the process of shutting down, this process will be canceled.

Remarks

This function is called just before a workbook is closed.

Note that it will only be called if event-sinking is switched on (using CXllApp::SetSinkEvents()).

You can override the method in your application class to react to the event. The default method does nothing and returns FALSE.

Implementation note

You should only implement this function if you need access to Excel's COM interfaces. To handle events, you should usually use the event model. If you particularly need to call an add-in function to handle the event, use the much simpler mechanism provided by CXllApp::SetComEventHandler().

Requirements

Header: xllplus.h

See Also

CXllApp Class | CXllApp Methods | CXllApp::OnNewWorkbook() | CXllApp::OnWorkbookOpen() | CXllApp::OnWorkbookBeforeSave()