ChartSheetBase.ChartWizard Method

Definition

Namespace:

Microsoft.Office.Tools.Excel

Assembly:

Microsoft.Office.Tools.Excel.v4.0.Utilities.dll

Modifies the properties of the given ChartSheetBase.

public void ChartWizard (object source, object gallery, object format, object plotBy, object categoryLabels, object seriesLabels, object hasLegend, object title, object categoryTitle, object valueTitle, object extraTitle);

member this.ChartWizard : obj * obj * obj * obj * obj * obj * obj * obj * obj * obj * obj -> unit

Public Sub ChartWizard (Optional source As Object, Optional gallery As Object, Optional format As Object, Optional plotBy As Object, Optional categoryLabels As Object, Optional seriesLabels As Object, Optional hasLegend As Object, Optional title As Object, Optional categoryTitle As Object, Optional valueTitle As Object, Optional extraTitle As Object)

Parameters

source

Object

The range that contains the source data for the new chart. If this argument is omitted, Microsoft Office Excel edits the active chart sheet or the selected chart on the active worksheet.

gallery

Object

The chart type.

format

Object

The option number for the built-in autoformats. Can be a number from 1 through 10, depending on the gallery type. If this argument is omitted, Microsoft Office Excel chooses a default value based on the gallery type and data source.

plotBy

Object

Specifies whether the data for each series is in rows or columns. Can be one of the following XlRowCol constants: xlRows or xlColumns.

categoryLabels

Object

An integer specifying the number of rows or columns within the source range that contain category labels. Legal values are from 0 (zero) through one less than the maximum number of the corresponding categories or series.

seriesLabels

Object

The number of rows or columns within the source range that contain series labels. Legal values are from 0 (zero) through one less than the maximum number of the corresponding categories or series.

hasLegend

Object

true to include a legend.

title

Object

The chart title text.

categoryTitle

Object

The category axis title text.

valueTitle

Object

The value axis title text

extraTitle

Object

The series axis title for 3-D charts or the second value axis title for 2-D charts.

Examples

The following code example uses the ChartWizard method to set the data source and the chart type of the current Microsoft.Office.Tools.Excel.ChartSheetBase.

private void ModifyChartSheet()
{
    Globals.Sheet1.Range["A1", "A5"].Value2 = 22;
    Globals.Sheet1.Range["B1", "B5"].Value2 = 55;

    this.ChartWizard(Globals.Sheet1.Range["A1", "B5"],
        Excel.XlChartType.xl3DColumn,false,
        "Revised chart");
}

Private Sub ModifyChartSheet()
    Globals.Sheet1.Range("A1", "A5").Value2 = 22
    Globals.Sheet1.Range("B1", "B5").Value2 = 55

    Me.ChartWizard(Source:=Globals.Sheet1.Range("A1", "B5"), _
        Gallery:=Excel.XlChartType.xl3DColumn, _
        HasLegend:=False, Title:="Revised chart")
End Sub

Remarks

You can use this method to quickly format a Microsoft.Office.Tools.Excel.ChartSheetBase without setting all the individual properties. This method is non-interactive, and it changes only the specified properties.

If Source is omitted and either the selection is not an embedded chart on the active worksheet or the active sheet is not an existing chart, this method fails and an error occurs.

Optional Parameters

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