Chart.XYGroups Method

Article
01/07/2014

On a 2-D chart, returns an object that represents either a single scatter chart group (a ChartGroup object) or a collection of the scatter chart groups (a ChartGroups collection).

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

Syntax

'Declaration
Function XYGroups ( _
    Index As Object _
) As Object

Object XYGroups(
    Object Index
)

Parameters

Index
Type: System.Object

Specifies the chart group.

Return Value

Type: System.Object

Remarks

Optional Parameters

For information on optional parameters, see Optional Parameters in Office Solutions.

Examples

The following code example creates an XY scatter chart Chart and then uses the XYGroups method to display the axis group.

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

    Dim Chart1 As Microsoft.Office.Tools.Excel.Chart = _
        Me.Controls.AddChart(Me.Range("D2", "H12"), "Chart1")

    Chart1.SetSourceData(Me.Range("A1", "B5"), Excel.XlRowCol.xlColumns)
    Chart1.ChartType = Excel.XlChartType.xlXYScatterLines

    Dim group As Excel.ChartGroup = CType(Chart1.XYGroups(1), _
        Excel.ChartGroup)

    MsgBox("The axis group is: " & group.AxisGroup.ToString())
End Sub

private void UseXYGroups()
{
    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.xlXYScatterLines;

    Excel.ChartGroup group =
        (Excel.ChartGroup)chart1.XYGroups(1);

    MessageBox.Show("The axis group is: " + 
        group.AxisGroup.ToString());
}

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via