WorkbookBase.SheetBeforeDoubleClick Event

Definition

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

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

Event Type

Examples

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

This example is for a document-level customization.

private void WorkbookSheetBeforeDoubleClick()
{
    this.SheetBeforeDoubleClick +=
        new Excel.WorkbookEvents_SheetBeforeDoubleClickEventHandler(
        ThisWorkbook_SheetBeforeDoubleClick);
}

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

    MsgBox("Double-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