Share via


WorkbookBase.SheetBeforeRightClick Event

Definition

Occurs when any worksheet is right-clicked, before the default right-click action.

public:
 event Microsoft::Office::Interop::Excel::WorkbookEvents_SheetBeforeRightClickEventHandler ^ SheetBeforeRightClick;
public event Microsoft.Office.Interop.Excel.WorkbookEvents_SheetBeforeRightClickEventHandler SheetBeforeRightClick;
member this.SheetBeforeRightClick : Microsoft.Office.Interop.Excel.WorkbookEvents_SheetBeforeRightClickEventHandler 
Public Custom Event SheetBeforeRightClick As WorkbookEvents_SheetBeforeRightClickEventHandler 

Event Type

Examples

The following code example demonstrates a handler for the SheetBeforeRightClick event. The event handler informs the user that right-clicking is not allowed for the worksheet, and then sets the Cancel parameter of the WorkbookEvents_SheetBeforeRightClickEventHandler event handler to true so that Microsoft Office Excel cancels the right-click action.

This example is for a document-level customization.

private void WorkbookSheetBeforeRightClick()
{
    this.SheetBeforeRightClick +=
        new Excel.WorkbookEvents_SheetBeforeRightClickEventHandler(
        ThisWorkbook_SheetBeforeRightClick);
}

void ThisWorkbook_SheetBeforeRightClick(object Sh,
    Excel.Range Target, ref bool Cancel)
{
    MessageBox.Show("Right-clicking in " + ((Excel.Worksheet)Sh).Name +
        " is not allowed.");
    Cancel = true;
}
Sub ThisWorkbook_SheetBeforeRightClick(ByVal Sh As Object, _
    ByVal Target As Excel.Range, ByRef Cancel As Boolean) _
    Handles Me.SheetBeforeRightClick

    MsgBox("Right-clicking in " & CType(Sh, Excel.Worksheet).Name & _
        " is not allowed.")
    Cancel = True
End Sub

Remarks

This event does not occur on chart sheets.

Applies to