Chart Interface

Definition

Namespace:

Microsoft.Office.Interop.Excel

Assembly:

Microsoft.Office.Interop.Excel.dll

Represents a chart in a workbook. The chart can be either an embedded chart (contained in a ChartObject) or a separate chart sheet.

public interface class Chart : Microsoft::Office::Interop::Excel::_Chart, Microsoft::Office::Interop::Excel::ChartEvents_Event

[System.Runtime.InteropServices.Guid("000208D6-0000-0000-C000-000000000046")]
public interface Chart : Microsoft.Office.Interop.Excel._Chart, Microsoft.Office.Interop.Excel.ChartEvents_Event

Public Interface Chart
Implements _Chart, ChartEvents_Event

Derived

Microsoft.Office.Interop.Excel.ChartClass

Attributes

GuidAttribute

Implements

_Chart ChartEvents_Event

Remarks

This is a .NET interface derived from a COM coclass that is required by managed code for interoperability with the corresponding COM object. Use this derived interface to access all method, property, and event members of the COM object. However, if a method or event you want to use shares the same name under the same COM object, cast to the corresponding primary interface to call the method, and cast to the latest events interface to connect to the event. Refer to this topic for information about the COM object. For information about the method and property members of the COM object, see _Chart.

The following properties for returning a Chart object are described in this section:

• Chart property
• Charts property
• ActiveChart property
• ActiveSheet property

Chart Property

Use the Chart property to return a Chart object that represents the chart contained in a ChartObject object.

Charts Property

The Charts collection contains a Chart object for each chart sheet in a workbook. Use Charts(index), where index is the chart-sheet index number or name, to return a single Chart object.

The chart index number represents the position of the chart sheet on the workbook tab bar. All chart sheets are included in the index count, even if they’re hidden. The chart sheet name is shown on the workbook tab for the chart. You can use the Name property to set or return the chart name.

The Chart object is also a member of the Sheets collection. The Sheets collection contains all the sheets in the workbook (both chart sheets and worksheets). Use Sheets(index), where index is the sheet index number or name, to return a single sheet.

ActiveChart Property

When a chart is the active object, you can use the ActiveChart property to refer to it. A chart sheet is active if the user has selected it or it’s been activated with the Activate() method.

An embedded chart is active if the user has selected it or the ChartObject object that it’s contained in has been activated with the Activate method.

ActiveSheet Property

When a chart sheet is the active sheet, you can use the ActiveSheet property to refer to it.

Properties

_CodeName	Reserved for internal use. (Inherited from _Chart)
Application	When used without an object qualifier, this property returns an Application object that represents the Microsoft Excel application. When used with an object qualifier, this property returns an Application object that represents the creator of the specified object (you can use this property with an OLE Automation object to return the application of that object). (Inherited from _Chart)
Area3DGroup	Returns a ChartGroup object that represents the area chart group on a 3-D chart. (Inherited from _Chart)
AutoScaling	True if Microsoft Excel scales a 3-D chart so that it's closer in size to the equivalent 2-D chart. The RightAngleAxes property must be True. (Inherited from _Chart)
BackWall	Returns a Walls object that allows the user to individually format the back wall of a 3-D chart. Read-only. (Inherited from _Chart)
Bar3DGroup	Returns a ChartGroup object that represents the bar chart group on a 3-D chart. (Inherited from _Chart)
BarShape	Returns or sets the shape used with the 3-D bar or column chart. (Inherited from _Chart)
CategoryLabelLevel	Returns an XlCategoryLabelLevel constant referring to the level of where the category labels are being sourced from. Integer (int in C#) Read/Write. (Inherited from _Chart)
ChartArea	Returns a ChartArea object that represents the complete chart area for the chart. (Inherited from _Chart)
ChartColor	Returns or sets an Integer (int in C#) that represents the color scheme for the chart. Read-write. (Inherited from _Chart)
ChartStyle	Returns or sets the chart style for the chart. Read/write. (Inherited from _Chart)
ChartTitle	Returns a ChartTitle object that represents the title of the specified chart. (Inherited from _Chart)
ChartType	Returns or sets the chart type. (Inherited from _Chart)
CodeName	Returns the code name for the object. (Inherited from _Chart)
Column3DGroup	Returns a ChartGroup object that represents the column chart group on a 3-D chart. (Inherited from _Chart)
Corners	Returns a Corners object that represents the corners of a 3-D chart. (Inherited from _Chart)
Creator	Returns a constant in the XlCreator enumeration that indicates the application in which this object was created. If the object was created in Microsoft Excel, this property returns the string XCEL, which is equivalent to the hexadecimal number 5843454C. (Inherited from _Chart)
DataTable	Returns a DataTable object that represents the chart data table. (Inherited from _Chart)
DepthPercent	Returns or sets the depth of a 3-D chart as a percentage of the chart width (between 20 and 2000 percent). (Inherited from _Chart)
DisplayBlanksAs	Returns or sets the way that blank cells are plotted on a chart. Can be one of the following XlDisplayBlanksAs constants: xlNotPlotted, xlInterpolated, or xlZero. (Inherited from _Chart)
Dummy24	(Inherited from _Chart)
Dummy25	(Inherited from _Chart)
Elevation	Returns or sets the elevation of the 3-D chart view in degrees. (Inherited from _Chart)
Floor	Returns a Floor object that represents the floor of the 3-D chart. (Inherited from _Chart)
GapDepth	Returns or sets the distance between the data series in a 3-D chart as a percentage of the marker width. The value of this property must be between 0 and 500. (Inherited from _Chart)
HasAxis[Object, Object]	Returns or sets which axes exist on the chart. (Inherited from _Chart)
HasDataTable	True if the chart has a data table. (Inherited from _Chart)
HasHiddenContent	(Inherited from _Chart)
HasLegend	True if the chart has a legend. (Inherited from _Chart)
HasPivotFields	True if the PivotChart controls are displayed on the specified PivotChart report. The default value is True. For a regular chart, this property always returns False and cannot be set. (Inherited from _Chart)
HasTitle	True if the axis or chart has a visible title. (Inherited from _Chart)
HeightPercent	Returns or sets the height of a 3-D chart as a percentage of the chart width (between 5 and 500 percent). (Inherited from _Chart)
Hyperlinks	Returns a Hyperlinks collection that represents the hyperlinks for the range or worksheet. (Inherited from _Chart)
Index	Returns the index number of the object within the collection of similar objects. (Inherited from _Chart)
Legend	Returns a Legend object that represents the legend for the chart. (Inherited from _Chart)
Line3DGroup	Returns a ChartGroup object that represents the line chart group on a 3-D chart. (Inherited from _Chart)
MailEnvelope	Represents an e-mail header for a document. (Inherited from _Chart)
Name	Returns or sets the name of the object. (Inherited from _Chart)
Next	Returns a Chart object that represents the next sheet or cell. (Inherited from _Chart)
OnDoubleClick	Reserved for internal use. (Inherited from _Chart)
OnSheetActivate	Reserved for internal use. (Inherited from _Chart)
OnSheetDeactivate	Reserved for internal use. (Inherited from _Chart)
PageSetup	Returns a PageSetup object that contains all the page setup settings for the specified object. (Inherited from _Chart)
Parent	Returns the parent object for the specified object. (Inherited from _Chart)
Perspective	Returns or sets the perspective for the 3-D chart view. Must be between 0 and 100. This property is ignored if the RightAngleAxes property is True. (Inherited from _Chart)
Pie3DGroup	Returns a ChartGroup object that represents the pie chart group on a 3-D chart. (Inherited from _Chart)
PivotLayout	Returns a PivotLayout object that represents the placement of fields in a PivotTable report and the placement of axes in a PivotChart report. (Inherited from _Chart)
PlotArea	Returns a PlotArea object that represents the plot area of a chart. (Inherited from _Chart)
PlotBy	Returns or sets the way columns or rows are used as data series on the chart. Can be one of the following XlRowCol constants: xlColumns or xlRows. For PivotChart reports, this property is read-only and always returns xlColumns. (Inherited from _Chart)
PlotVisibleOnly	True if only visible cells are plotted. False if both visible and hidden cells are plotted. (Inherited from _Chart)
Previous	Returns a Chart object that represents the previous sheet or cell. (Inherited from _Chart)
PrintedCommentPages	Gets the number of comment pages that will be printed for the current chart. (Inherited from _Chart)
ProtectContents	True if the contents of the sheet are protected. This protects the entire chart. (Inherited from _Chart)
ProtectData	True if series formulas cannot be modified by the user. (Inherited from _Chart)
ProtectDrawingObjects	True if shapes are protected. (Inherited from _Chart)
ProtectFormatting	True if chart formatting cannot be modified by the user. (Inherited from _Chart)
ProtectGoalSeek	True if the user cannot modify chart data points with mouse actions. (Inherited from _Chart)
ProtectionMode	True if user-interface-only protection is turned on. To turn on user interface protection, use the Protect(Object, Object, Object, Object, Object) method with the UserInterfaceOnly argument set to True. (Inherited from _Chart)
ProtectSelection	True if chart elements cannot be selected. (Inherited from _Chart)
RightAngleAxes	True if the chart axes are at right angles, independent of chart rotation or elevation. Applies only to 3-D line, column, and bar charts. (Inherited from _Chart)
Rotation	Returns or sets the rotation of the 3-D chart view (the rotation of the plot area around the z-axis in degrees). The value of this property must be from 0 to 360, except for 3-D bar charts, where the value must be from 0 to 44. The default value is 20. Applies only to 3-D charts. (Inherited from _Chart)
Scripts	Returns the Scripts collection, which contains Script objects representing blocks of script or code in the specified document when it’s saved as a Web page. (Inherited from _Chart)
SeriesNameLevel	Returns an XlSeriesNameLevel constant referring to the level of where the series names are being sourced from. Integer (int in C#) Read/Write. (Inherited from _Chart)
Shapes	Returns a Shapes object that represents all the shapes on the worksheet or chart sheet. Read-only. (Inherited from _Chart)
ShowAllFieldButtons	Gets or sets whether to display all field buttons on a PivotChart. (Inherited from _Chart)
ShowAxisFieldButtons	Gets or sets whether to display axis field buttons on a PivotChart. (Inherited from _Chart)
ShowDataLabelsOverMaximum	Returns or sets whether to show the data labels when the value is greater than the maximum value on the value axis. Read/write. (Inherited from _Chart)
ShowLegendFieldButtons	Gets or sets whether to display legend field buttons on a PivotChart. (Inherited from _Chart)
ShowReportFilterFieldButtons	Gets or sets whether to display the report filter field buttons on a PivotChart. (Inherited from _Chart)
ShowValueFieldButtons	Gets or sets whether to display the value field buttons on a PivotChart. (Inherited from _Chart)
ShowWindow	True if the embedded chart is displayed in a separate window. The Chart object used with this property must refer to an embedded chart. (Inherited from _Chart)
SideWall	Returns a Walls object that allows the user to individually format the side wall of a 3-D chart. Read-only. (Inherited from _Chart)
SizeWithWindow	True if Microsoft Excel resizes the chart to match the size of the chart sheet window. False if the chart size isn't attached to the window size. Applies only to chart sheets (doesn't apply to embedded charts). (Inherited from _Chart)
SubType	Reserved for internal use. (Inherited from _Chart)
SurfaceGroup	Returns a ChartGroup object that represents the surface chart group of a 3-D chart. (Inherited from _Chart)
Tab	Returns a Tab object for a chart or a worksheet. (Inherited from _Chart)
Type	Reserved for internal use. (Inherited from _Chart)
Visible	Determines whether the object is visible. (Inherited from _Chart)
Walls	Returns a Walls object that represents the walls of the 3-D chart. (Inherited from _Chart)
WallsAndGridlines2D	True if gridlines are drawn two-dimensionally on a 3-D chart. (Inherited from _Chart)

Methods

_ApplyDataLabels(XlDataLabelsType, Object, Object, Object)	Reserved for internal use. (Inherited from _Chart)
_Dummy23()	Reserved for internal use. (Inherited from _Chart)
_Evaluate(Object)	Reserved for internal use. (Inherited from _Chart)
_PrintOut(Object, Object, Object, Object, Object, Object, Object)	Reserved for internal use. (Inherited from _Chart)
_Protect(Object, Object, Object, Object, Object)	Reserved for internal use. (Inherited from _Chart)
_SaveAs(String, Object, Object, Object, Object, Object, Object, Object, Object)	Reserved for internal use. (Inherited from _Chart)
ApplyChartTemplate(String)	Applies a standard or custom chart type to a chart. (Inherited from _Chart)
ApplyCustomType(XlChartType, Object)	Applies a standard or custom chart type to a chart. (Inherited from _Chart)
ApplyDataLabels(XlDataLabelsType, Object, Object, Object, Object, Object, Object, Object, Object, Object)	Applies data labels to a point, a series, or all the series in a chart. (Inherited from _Chart)
ApplyLayout(Int32, Object)	Applies the layouts shown in the ribbon. (Inherited from _Chart)
Arcs(Object)	Reserved for internal use. (Inherited from _Chart)
AreaGroups(Object)	On a 2-D chart, returns an object that represents either a single area chart group (a ChartGroup object) or a collection of the area chart groups (a ChartGroups collection). (Inherited from _Chart)
AutoFormat(Int32, Object)	Reserved for internal use. (Inherited from _Chart)
Axes(Object, XlAxisGroup)	Returns an object that represents either a single axis or a collection of the axes on the chart. (Inherited from _Chart)
BarGroups(Object)	On a 2-D chart, returns an object that represents either a single bar chart group (a ChartGroup object) or a collection of the bar chart groups (a ChartGroups collection). (Inherited from _Chart)
Buttons(Object)	Reserved for internal use. (Inherited from _Chart)
ChartGroups(Object)	Returns an object that represents 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. (Inherited from _Chart)
ChartObjects(Object)	Returns an object that represents either a single embedded chart (a ChartObject object) or a collection of all the embedded charts (a ChartObjects object) on the sheet. (Inherited from _Chart)
ChartWizard(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object)	Modifies the properties of the given chart. You can use this method to quickly format a chart without setting all the individual properties. This method is non-interactive, and it changes only the specified properties. (Inherited from _Chart)
CheckBoxes(Object)	Reserved for internal use. (Inherited from _Chart)
CheckSpelling(Object, Object, Object, Object)	Checks the spelling of an object and displays the Spelling dialog box (Inherited from _Chart)
ClearToMatchColorStyle()	Clears all colors on the specified chart that do not follow the color style applied to the chart. (Inherited from _Chart)
ClearToMatchStyle()	Clears the chart elements formatting to automatic. (Inherited from _Chart)
ColumnGroups(Object)	On a 2-D chart, returns an object that represents either a single column chart group (a ChartGroup object) or a collection of the column chart groups (a ChartGroups collection). (Inherited from _Chart)
Copy(Object, Object)	Copies the sheet to another location in the workbook. (Inherited from _Chart)
CopyChartBuild()	Reserved for internal use. (Inherited from _Chart)
CopyPicture(XlPictureAppearance, XlCopyPictureFormat, XlPictureAppearance)	Copies the selected object to the Clipboard as a picture. (Inherited from _Chart)
CreatePublisher(Object, XlPictureAppearance, XlPictureAppearance, Object, Object, Object, Object)	Reserved for internal use.This member is for Macintosh only and should not be used. (Inherited from _Chart)
Delete()	Deletes the object. (Inherited from _Chart)
DeleteHiddenContent()	(Inherited from _Chart)
Deselect()	Cancels the selection for the specified chart. (Inherited from _Chart)
DoughnutGroups(Object)	On a 2-D chart, returns an object that represents either a single doughnut chart group (a ChartGroup object) or a collection of the doughnut chart groups (a ChartGroups collection). (Inherited from _Chart)
DrawingObjects(Object)	Reserved for internal use. (Inherited from _Chart)
Drawings(Object)	Reserved for internal use. (Inherited from _Chart)
DropDowns(Object)	For callouts with an explicitly set drop value, this property returns the vertical distance (in points) from the edge of the text bounding box to the place where the callout line attaches to the text box. Read-only Single. (Inherited from _Chart)
Evaluate(Object)	Converts a Microsoft Excel name to an object or a value. (Inherited from _Chart)
Export(String, Object, Object)	Exports the chart in a graphic format. (Inherited from _Chart)
ExportAsFixedFormat(XlFixedFormatType, Object, Object, Object, Object, Object, Object, Object, Object)	Exports to a file of the specified format. (Inherited from _Chart)
FullSeriesCollection(Object)	Enables retrieving the filtered out series specified by the Index argument. (Inherited from _Chart)
GetChartElement(Int32, Int32, Int32, Int32, Int32)	Returns information about the chart element at specified X and Y coordinates. This method is unusual in that you specify values for only the first two arguments. Microsoft Excel fills in the other arguments, and your code should examine those values when the method returns. (Inherited from _Chart)
GroupBoxes(Object)	Reserved for internal use. (Inherited from _Chart)
GroupObjects(Object)	Reserved for internal use. (Inherited from _Chart)
Labels(Object)	Reserved for internal use. (Inherited from _Chart)
LineGroups(Object)	On a 2-D chart, returns an object that represents either a single line chart group (a ChartGroup object) or a collection of the line chart groups (a ChartGroups collection). (Inherited from _Chart)
Lines(Object)	Reserved for internal use. f (Inherited from _Chart)
ListBoxes(Object)	Returns or sets the text entries in the specified list box or a combo box, as an array of strings, or returns or sets a single text entry. An error occurs if there are no entries in the list. (Inherited from _Chart)
Location(XlChartLocation, Object)	Moves the chart to a new location. (Inherited from _Chart)
Move(Object, Object)	Moves the sheet to another location in the workbook. (Inherited from _Chart)
OLEObjects(Object)	Returns an object that represents either a single OLE object (an OLEObject) or a collection of all OLE objects (an OLEObjects collection) on the chart or sheet. (Inherited from _Chart)
OptionButtons(Object)	Reserved for internal use. (Inherited from _Chart)
Ovals(Object)	Reserved for internal use. (Inherited from _Chart)
Paste(Object)	Pastes chart data from the Clipboard into the specified chart. (Inherited from _Chart)
Pictures(Object)	Reserved for internal use. (Inherited from _Chart)
PieGroups(Object)	On a 2-D chart, returns an object that represents either a single pie chart group (a ChartGroup object) or a collection of the pie chart groups (a ChartGroups collection). (Inherited from _Chart)
PrintOut(Object, Object, Object, Object, Object, Object, Object, Object)	Prints the object. (Inherited from _Chart)
PrintOutEx(Object, Object, Object, Object, Object, Object, Object, Object)	Reserved for internal use. (Inherited from _Chart)
PrintPreview(Object)	Shows a preview of the object as it would look when printed. (Inherited from _Chart)
Protect(Object, Object, Object, Object, Object)	Protects a chart so that it cannot be modified. (Inherited from _Chart)
RadarGroups(Object)	On a 2-D chart, returns an object that represents either a single radar chart group (a ChartGroup object) or a collection of the radar chart groups (a ChartGroups collection). (Inherited from _Chart)
Rectangles(Object)	Reserved for internal use. (Inherited from _Chart)
Refresh()	Updates the cache of the Chart or PivotTable object. (Inherited from _Chart)
SaveAs(String, Object, Object, Object, Object, Object, Object, Object, Object, Object)	Saves changes to the chart or worksheet in a different file. (Inherited from _Chart)
SaveChartTemplate(String)	Saves a custom chart template to the list of available chart templates. (Inherited from _Chart)
ScrollBars(Object)	Reserved for internal use. (Inherited from _Chart)
Select(Object)	Selects the object. (Inherited from _Chart)
SeriesCollection(Object)	Returns an object that represents either a single series (a Series object) or a collection of all the series (a SeriesCollection collection) in the chart or chart group. (Inherited from _Chart)
SetBackgroundPicture(String)	Sets the background graphic for a worksheet or chart. (Inherited from _Chart)
SetDefaultChart(Object)	Specifies the name of the chart template that Microsoft Excel uses when creating new charts. (Inherited from _Chart)
SetElement(MsoChartElementType)	Sets chart elements on a chart. Read/write. (Inherited from _Chart)
SetSourceData(Range, Object)	Sets the source data range for the chart. (Inherited from _Chart)
Spinners(Object)	Reserved for internal use. (Inherited from _Chart)
TextBoxes(Object)	Reserved for internal use. (Inherited from _Chart)
Unprotect(Object)	Removes protection from a sheet or workbook. This method has no effect if the sheet or workbook isn't protected. (Inherited from _Chart)
XYGroups(Object)	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). (Inherited from _Chart)

Events

Activate	Occurs when a chart sheet or embedded chart is activated. (Inherited from ChartEvents_Event)
BeforeDoubleClick	Occurs when an embedded chart is double-clicked, before the default double-click action. (Inherited from ChartEvents_Event)
BeforeRightClick	Occurs when an embedded chart is right-clicked, before the default right-click action. (Inherited from ChartEvents_Event)
Calculate	Occurs after the chart plots new or changed data. (Inherited from ChartEvents_Event)
Deactivate	Occurs when the chart is deactivated. (Inherited from ChartEvents_Event)
DragOver	Occurs when a range of cells is dragged over a chart. (Inherited from ChartEvents_Event)
DragPlot	Occurs when a range of cells is dragged and dropped on a chart. (Inherited from ChartEvents_Event)
MouseDown	Occurs when a mouse button is pressed while the pointer is over a chart. (Inherited from ChartEvents_Event)
MouseMove	Occurs when the position of the mouse pointer changes over a chart. (Inherited from ChartEvents_Event)
MouseUp	Occurs when a mouse button is released while the pointer is over a chart. (Inherited from ChartEvents_Event)
Resize	Occurs when the chart is resized. (Inherited from ChartEvents_Event)
Select	Occurs when a chart element is selected. (Inherited from ChartEvents_Event)
SeriesChange	Occurs when the user changes the value of a chart data point. (Inherited from ChartEvents_Event)