ControlCollection.AddChart Method (Range, String)

  • Article

Adds a new Chart control to the worksheet at the range specified.

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

Syntax

'Declaration
Function AddChart ( _
    range As Range, _
    name As String _
) As Chart

Chart AddChart(
    Range range,
    string name
)

Parameters

  • range
    Type: Range

    A Range that provides the bounds for the control.

Return Value

Type: Microsoft.Office.Tools.Excel.Chart
The Chart control that was added to the ControlCollection instance.

Exceptions

Exception Condition
ArgumentNullException

The name or range argument is nulla null reference (Nothing in Visual Basic), or the name argument has zero length.
ControlNameAlreadyExistsException

A control with the same name is already in the ControlCollection instance.
InvalidRangeException

The range that was specified is not valid. Multi-area ranges cannot be used. The range should be on the same worksheet as the ControlCollection instance.

Remarks

The AddChart method enables you to add Chart controls to the end of the ControlCollection. To remove a Chart control that was previously added programmatically, use the Remove method.

Examples

The following code example inserts the number 16 to cells E1 through E3 and the number 24 to cells F1 through F3. The code then creates a Chart control to cells A1 through C8 and passes cells E1 through F3 to the SetSourceData method to populate the chart with data.

Private Sub ExcelAddRangeChart()
    Me.Range("E1", "E3").Value2 = 16
    Me.Range("F1", "F3").Value2 = 24

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

    Chart1.SetSourceData(Me.Range("E1", "F5"), _
        Excel.XlRowCol.xlColumns)
    Chart1.ChartType = Excel.XlChartType. _
        xlColumnClustered

End Sub

private void ExcelAddRangeChart()
{
    this.Range["E1", "E3"].Value2 = 16;
    this.Range["F1", "F3"].Value2 = 24;

    Microsoft.Office.Tools.Excel.Chart chart1 =
        this.Controls.AddChart(this.Range["A1", "C8"], "Chart1");

    chart1.SetSourceData(this.Range["E1", "F5"], Excel.XlRowCol.xlColumns);
    chart1.ChartType = Excel.XlChartType.xlColumnClustered;
}

.NET Framework Security

See Also

Reference

ControlCollection Interface

AddChart Overload

Microsoft.Office.Tools.Excel Namespace