CXllApp::OnSheetBeforeRightClick

Called by the framework when the user right-clicks in a worksheet

[C++]
virtual BOOL OnSheetBeforeRightClick(
   LPDISPATCH dispWorksheet,
   LPDISPATCH dispRange
);

Parameters

dispWorksheet: Pointer to dispatch interface of type Excel.Worksheet.
dispRange: Pointer to dispatch interface of type Excel.Range, representing the cell or cells that were clicked.

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, popup menus will be disabled.

Remarks

This function is called whenever the user right-clicks in a worksheet.

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. If you just want to call an add-in function, use the much simpler mechanism provided by CXllApp::SetComEventHandler().

Requirements