Chart.BeforeDoubleClick Event

Reference

Definition

Namespace:: Microsoft.Office.Tools.Excel

Assembly:: Microsoft.Office.Tools.Excel.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Occurs when the Chart control is double-clicked, before the default double-click action.

public:
 event Microsoft::Office::Interop::Excel::ChartEvents_BeforeDoubleClickEventHandler ^ BeforeDoubleClick;

event Microsoft.Office.Interop.Excel.ChartEvents_BeforeDoubleClickEventHandler BeforeDoubleClick;

member this.BeforeDoubleClick : Microsoft.Office.Interop.Excel.ChartEvents_BeforeDoubleClickEventHandler

Event BeforeDoubleClick As ChartEvents_BeforeDoubleClickEventHandler

Event Type

ChartEvents_BeforeDoubleClickEventHandler

Examples

The following code example creates a Chart with a handler for the BeforeDoubleClick event that displays a message box when an axis of the chart is double-clicked. The example also sets the Cancel parameter of the event handler to true so that the chart does not receive the double click action when the user double-clicks an axis.

private void DisallowDoubleClicksOnAxis()
{
    this.Range["A1", "A5"].Value2 = 22;
    this.Range["B1", "B5"].Value2 = 55;

    Microsoft.Office.Tools.Excel.Chart chart1 =
        this.Controls.AddChart(this.Range["D2", "H12"], 
        "chart1");
    chart1.SetSourceData(this.Range["A1", "B5"], 
        Excel.XlRowCol.xlColumns);
    chart1.ChartType = Excel.XlChartType.xl3DColumn;

    chart1.BeforeDoubleClick +=
        new Excel.ChartEvents_BeforeDoubleClickEventHandler(
        chart1_BeforeDoubleClick);
}

void chart1_BeforeDoubleClick(int ElementID, int Arg1, 
    int Arg2, ref bool Cancel)
{
    if (ElementID == (int)Excel.XlChartItem.xlAxis)
    {
        MessageBox.Show("Formatting this axis is not allowed.");
        Cancel = true;
    }
}

WithEvents DoubleClickChart As Microsoft.Office.Tools.Excel.Chart

Private Sub DisallowDoubleClicksOnAxis()
    Me.Range("A1", "A5").Value2 = 22
    Me.Range("B1", "B5").Value2 = 55

    DoubleClickChart = Me.Controls.AddChart(Me.Range("D2", "H12"), _
        "DoubleClickChart")
    DoubleClickChart.SetSourceData(Me.Range("A1", "B5"), _
        Excel.XlRowCol.xlColumns)
    DoubleClickChart.ChartType = Excel.XlChartType.xl3DColumn
End Sub

Sub DoubleClickChart_BeforeDoubleClick(ByVal ElementID As Integer, _
    ByVal Arg1 As Integer, ByVal Arg2 As Integer, _
    ByRef Cancel As Boolean) Handles DoubleClickChart.BeforeDoubleClick

    If ElementID = Fix(Excel.XlChartItem.xlAxis) Then
        MsgBox("Formatting this axis is not allowed.")
        Cancel = True
    End If
End Sub

Remarks

The DoubleClick method does not cause this event to occur.

Applies to

Share via