This documentation is archived and is not being maintained.

Worksheet.BeforeRightClick Event

Office 2007
Occurs when a worksheet is right-clicked, before the default right-click action.


expression.BeforeRightClick(Target, Cancel)

expression   A variable that represents a Worksheet object.


NameRequired/OptionalData TypeDescription
TargetRequiredRangeThe cell nearest to the mouse pointer when the right-click occurs.
CancelRequiredBooleanFalse when the event occurs. If the event procedure sets this argument to True, the default right-click action doesn't occur when the procedure is finished.


Like other worksheet events, this event doesn't occur if you right-click while the pointer is on a shape or a command bar (a toolbar or menu bar).


This example adds a new menu item to the shortcut menu for cells B1:B10.

Visual Basic for Applications
Private Sub Worksheet_BeforeRightClick(ByVal Target As Range, _
        Cancel As Boolean)
    Dim icbc As Object
    For Each icbc In Application.CommandBars("cell").Controls
        If icbc.Tag = "brccm" Then icbc.Delete
    Next icbc
    If Not Application.Intersect(Target, Range("b1:b10")) _
        Is Nothing Then
            With Application.CommandBars("cell").Controls _
                .Add(Type:=msoControlButton, before:=6, _
           .Caption = "New Context Menu Item"
           .OnAction = "MyMacro"
           .Tag = "brccm"
        End With
    End If
End Sub