Share via


WorkbookBase.SheetBeforeRightClick Event

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

Namespace:  Microsoft.Office.Tools.Excel
Assembly:  Microsoft.Office.Tools.Excel.v4.0.Utilities (in Microsoft.Office.Tools.Excel.v4.0.Utilities.dll)

Syntax

'Declaration
Public Event SheetBeforeRightClick As WorkbookEvents_SheetBeforeRightClickEventHandler
public event WorkbookEvents_SheetBeforeRightClickEventHandler SheetBeforeRightClick

Remarks

This event does not occur on chart sheets.

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.

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
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;
}

.NET Framework Security

See Also

Reference

WorkbookBase Class

Microsoft.Office.Tools.Excel Namespace