ControlCollection.AddChart Method (Double, Double, Double, Double, String)

Article
06/14/2013

Adds a new Chart control to the worksheet in the specified size and location.

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

Syntax

'Declaration
Function AddChart ( _
    left As Double, _
    top As Double, _
    width As Double, _
    height As Double, _
    name As String _
) As Chart

Chart AddChart(
    double left,
    double top,
    double width,
    double height,
    string name
)

Parameters

left
Type: System.Double

The distance in points between the left edge of the control and the left edge of the worksheet.

top
Type: System.Double

The distance in points between the top edge of the control and the top edge of the worksheet.

width
Type: System.Double

The width of the control in points.

height
Type: System.Double

The height of the control in points.

name
Type: System.String

The name of 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 argument is nulla null reference (Nothing in Visual Basic) or has zero length.
ControlNameAlreadyExistsException	A control with the same name is already in 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 the top of the worksheet and passes cells E1 through F3 to the SetSourceData method to populate the chart with data.

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

    Dim Chart1 As Microsoft.Office.Tools.Excel. _
        Chart = Me.Controls.AddChart(0, 0, 130, _
        130, "Chart1")

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

End Sub

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

    Microsoft.Office.Tools.Excel.Chart chart1 =
        this.Controls.AddChart(0, 0, 130, 130, "chart1");

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

.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