Share via


Chart.ChartGroups(Object) Method

Definition

Gets either a single chart group (a ChartGroup object) or a collection of all the chart groups in the chart (a ChartGroups object).

public object ChartGroups (object Index);
abstract member ChartGroups : obj -> obj
Public Function ChartGroups (Optional Index As Object) As Object

Parameters

Index
Object

The chart group number.

Returns

Either a single chart group (a ChartGroup object) or a collection of all the chart groups in the chart (a ChartGroups object). The returned collection includes every type of group.

Examples

The following code example creates a column Chart and then uses the ChartGroups method to modify the space between the columns.

private void UseChartGroups()
{
    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;

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

    group.GapWidth = 400;
}
Private Sub UseChartGroups()
    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.xl3DColumn

    Dim group As Excel.ChartGroup = CType(Chart1.ChartGroups(1), _
        Excel.ChartGroup)
    group.GapWidth = 400
End Sub

Remarks

Optional Parameters

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

Applies to