_Chart.GetChartElement Method

Returns information about the chart element at specified X and Y coordinates. This method is unusual in that you specify values for only the first two arguments. Microsoft Excel fills in the other arguments, and your code should examine those values when the method returns.

Namespace:  Microsoft.Office.Interop.Excel
Assembly:  Microsoft.Office.Interop.Excel (in Microsoft.Office.Interop.Excel.dll)

Syntax

'Declaration
Sub GetChartElement ( _
    x As Integer, _
    y As Integer, _
    ByRef ElementID As Integer, _
    ByRef Arg1 As Integer, _
    ByRef Arg2 As Integer _
)
'Usage
Dim instance As _Chart
Dim x As Integer
Dim y As Integer
Dim ElementID As Integer
Dim Arg1 As Integer
Dim Arg2 As Integer

instance.GetChartElement(x, y, ElementID, _
    Arg1, Arg2)
void GetChartElement(
    int x,
    int y,
    ref int ElementID,
    ref int Arg1,
    ref int Arg2
)

Parameters

  • x
    Type: System.Int32

    Required Integer. The X coordinate of the chart element.

  • y
    Type: System.Int32

    Required Integer. The Y coordinate of the chart element.

  • ElementID
    Type: System.Int32

    Required Integer. When the method returns, this argument contains the XlChartItem value of the chart element at the specified coordinates. For more information, see the Remarks section.

  • Arg1
    Type: System.Int32

    Required Integer. When the method returns, this argument contains information related to the chart element. For more information, see the Remarks section.

  • Arg2
    Type: System.Int32

    Required Integer. When the method returns, this argument contains information related to the chart element. For more information, see the Remarks section.

Remarks

The value of ElementID after the method returns determines whether Arg1 and Arg2 contain any information, as shown in the following table.

ElementID

Arg1

Arg2

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

xlShape

ShapeIndex

None

xlTrendline

SeriesIndex

TrendLineIndex

xlXErrorBars

SeriesIndex

None

xlYErrorBars

SeriesIndex

None

The following table describes the meaning of Arg1 and Arg2 after the method returns.

Argument

Description

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. -1 if the drop zone type is xlDataField.

PointIndex

Specifies the offset within the Points collection for a specific point within a series. A value of –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.

See Also

Reference

_Chart Interface

_Chart Members

Microsoft.Office.Interop.Excel Namespace