ChartEvents_BeforeDoubleClickEventHandler Delegate

Definition

Namespace:

Microsoft.Office.Interop.Excel

Assembly:

Microsoft.Office.Interop.Excel.dll

A Delegate type used to add an event handler for the BeforeDoubleClick event. The BeforeDoubleClick event occurs when an embedded chart is double-clicked, before the default double-click action.

public delegate void ChartEvents_BeforeDoubleClickEventHandler(int ElementID, int Arg1, int Arg2, [Runtime::InteropServices::Out] bool % Cancel);

[System.Runtime.InteropServices.ComVisible(false)]
public delegate void ChartEvents_BeforeDoubleClickEventHandler(int ElementID, int Arg1, int Arg2, out bool Cancel);

Public Delegate Sub ChartEvents_BeforeDoubleClickEventHandler(ElementID As Integer, Arg1 As Integer, Arg2 As Integer, ByRef Cancel As Boolean)

Parameters

ElementID

Int32

Required. The double-clicked object.

Arg1

Int32

Depends on ElementID.

Arg2

Int32

Depends on ElementID.

Cancel

Boolean

Optional. False when the event occurs. If the event procedure sets this argument to True, the default double-click action isn't performed when the procedure is finished.

Attributes

ComVisibleAttribute

Remarks

The following table shows the arguments associated with each ElementID.

xlAxis	AxisIndex	AxisType
xlAxisTitle	AxisIndex	AxisType
xlDisplayUnitLabel	AxisIndex	AxisType
xlMajorGridlines	AxisIndex	AxisType
xlMinorGridlines	AxisIndex	AxisType
xlPivotChartDropZone	DropZoneType	None
xlPivotChartFieldButton	DropZoneType	PivotFieldIndex
xlDownBars	GroupIndex	None
xlDropLines	GroupIndex	None
xlHiLoLines	GroupIndex	None
xlRadarAxisLabels	GroupIndex	None
xlSeriesLines	GroupIndex	None
xlUpBars	GroupIndex	None
xlChartArea	None	None
xlChartTitle	None	None
xlCorners	None	None
xlDataTable	None	None
xlFloor	None	None
xlLegend	None	None
xlNothing	None	None
xlPlotArea	None	None
xlWalls	None	None
xlDataLabel	SeriesIndex	PointIndex
xlErrorBars	SeriesIndex	None
xlLegendEntry	SeriesIndex	None
xlLegendKey	SeriesIndex	None
xlSeries	SeriesIndex	PointIndex
xlTrendline	SeriesIndex	TrendLineIndex
xlXErrorBars	SeriesIndex	None
xlYErrorBars	SeriesIndex	None
xlShape	ShapeIndex	None

The following table describes the meaning of the arguments.

AxisIndex	Specifies whether the axis is primary or secondary. Can be one of the following XlAxisGroup constants: xlPrimary or xlSecondary.
AxisType	Specifies the axis type. Can be one of the following XlAxisType constants: xlCategory, xlSeriesAxis, or xlValue.
DropZoneType	Specifies the drop zone type: column, data, page, or row field. Can be one of the following XlPivotFieldOrientation constants: xlColumnField, xlDataField, xlPageField, or xlRowField. The column and row field constants specify the series and category fields, respectively.
GroupIndex	Specifies the offset within the ChartGroups collection for a specific chart group.
PivotFieldIndex	Specifies the offset within the PivotFields collection for a specific column (series), data, page, or row (category) field.
PointIndex	Specifies the offset within the Points collection for a specific point within a series. The value –1 indicates that all data points are selected.
SeriesIndex	Specifies the offset within the Series collection for a specific series.
ShapeIndex	Specifies the offset within the Shapes collection for a specific shape.
TrendlineIndex	Specifies the offset within the Trendlines collection for a specific trendline within a series.

The DoubleClick() method doesn't cause this event to occur.

This event doesn't occur when the user double-clicks the border of a cell.