ChartSheet Interface

  • Article

Represents a worksheet in document-level Excel projects created by using the Office development tools in Visual Studio.

Namespace:  Microsoft.Office.Tools.Excel
Assemblies:   Microsoft.Office.Tools.Excel.v4.0.Utilities (in Microsoft.Office.Tools.Excel.v4.0.Utilities.dll)
  Microsoft.Office.Tools.Excel (in Microsoft.Office.Tools.Excel.dll)

Syntax

'Declaration
<GuidAttribute("0bc69504-5797-4291-8178-cef15cc18b98")> _
Public Interface ChartSheet _
    Inherits IBindableComponent, IComponent, IDisposable, ISupportInitialize

[GuidAttribute("0bc69504-5797-4291-8178-cef15cc18b98")]
public interface ChartSheet : IBindableComponent, 
    IComponent, IDisposable, ISupportInitialize

The ChartSheet type exposes the following members.

Properties

  Name Description
Public property _CodeName Infrastructure.
Public property Application Gets an Application that represents the Microsoft Office Excel application.
Public property Area3DGroup Gets a ChartGroup that represents the area chart group on a 3-D Microsoft.Office.Tools.Excel.ChartSheet.
Public property AutoScaling Gets a value that indicates whether Microsoft Office Excel scales a 3-D Microsoft.Office.Tools.Excel.ChartSheet so that it is closer in size to the equivalent 2-D chart
Public property BackWall Gets an object that represents the back wall of a 3-D chart.
Public property Bar3DGroup Gets a ChartGroup that represents the bar chart group on a 3-D Microsoft.Office.Tools.Excel.ChartSheet.
Public property BarShape Gets or sets the shape used with the 3-D bar or column Microsoft.Office.Tools.Excel.ChartSheet.
Public property BindingContext Gets or sets the collection of currency managers for the IBindableComponent. (Inherited from IBindableComponent.)
Public property ChartArea Gets a ChartArea that represents the complete chart area for the Microsoft.Office.Tools.Excel.ChartSheet.
Public property ChartStyle Gets or sets the style of the chart.
Public property ChartTitle Gets a ChartTitle that represents the title of the specified Microsoft.Office.Tools.Excel.ChartSheet.
Public property ChartType Gets or sets the Microsoft.Office.Tools.Excel.ChartSheet type.
Public property CodeName Infrastructure.
Public property Column3DGroup Gets a ChartGroup that represents the column chart group on a 3-D Microsoft.Office.Tools.Excel.ChartSheet.
Public property Corners Gets a Corners object that represents the corners of a 3-D Microsoft.Office.Tools.Excel.ChartSheet.
Public property Creator Gets an XlCreator code that indicates the application in which the Microsoft.Office.Tools.Excel.ChartSheet was created.
Public property DataBindings Gets the collection of data-binding objects for this IBindableComponent. (Inherited from IBindableComponent.)
Public property DataHost Infrastructure.
Public property DataTable Gets a DataTable object that represents the Microsoft.Office.Tools.Excel.ChartSheet data table.
Public property DefaultExtension Gets the default extension for this ChartSheet object.
Public property DepthPercent Gets or sets the depth of a 3-D chart as a percentage of the Microsoft.Office.Tools.Excel.ChartSheet width.
Public property DisplayBlanksAs Gets or sets the way that blank cells are plotted on a Microsoft.Office.Tools.Excel.ChartSheet.
Public property Dummy24 Infrastructure.
Public property Dummy25 Infrastructure.
Public property Elevation Gets or sets the elevation of the 3-D Microsoft.Office.Tools.Excel.ChartSheet, in degrees.
Public property Extension Gets a custom extension for this ChartSheet object.
Public property Floor Gets a Floor object that represents the floor of the 3-D Microsoft.Office.Tools.Excel.ChartSheet.
Public property GapDepth Gets or sets the distance between the data series in a 3-D Microsoft.Office.Tools.Excel.ChartSheet, as a percentage of the marker width.
Public property HasAxis Gets or sets a value indicating whether a specific axis exists on the Microsoft.Office.Tools.Excel.ChartSheet.
Public property HasDataTable Gets or sets a value that indicates whether the Microsoft.Office.Tools.Excel.ChartSheet has a data table.
Public property HasLegend Gets or sets a value that indicates whether the Microsoft.Office.Tools.Excel.ChartSheet has a legend.
Public property HasPivotFields Gets or sets a value that indicates whether the PivotChart controls are displayed on the specified PivotChart report.
Public property HasTitle Gets or sets a value the indicates whether the Microsoft.Office.Tools.Excel.ChartSheet has a visible title.
Public property HeightPercent Gets or sets the height of a 3-D chart as a percentage of the Microsoft.Office.Tools.Excel.ChartSheet width.
Public property HostContext Infrastructure.
Public property Hyperlinks Gets a Hyperlinks collection that represents the hyperlinks for the Microsoft.Office.Tools.Excel.ChartSheet.
Public property Index Gets the index number of the Microsoft.Office.Tools.Excel.ChartSheet.
Public property InnerObject Gets a Chart that represents the underlying native object for the ChartSheet.
Public property ItemProvider Infrastructure.
Public property Legend Gets a Legend that represents the legend for the Microsoft.Office.Tools.Excel.ChartSheet.
Public property Line3DGroup Gets a ChartGroup that represents the line chart group on a 3-D Microsoft.Office.Tools.Excel.ChartSheet.
Public property MailEnvelope Represents an e-mail header for a document.
Public property Name Gets or sets the name of the Microsoft.Office.Tools.Excel.ChartSheet.
Public property Next Gets a Worksheet object that represents the next sheet.
Public property OnDoubleClick Infrastructure.
Public property OnSheetActivate Infrastructure.
Public property OnSheetDeactivate Infrastructure.
Public property PageSetup Gets a PageSetup that contains all the page setup settings for the Microsoft.Office.Tools.Excel.ChartSheet.
Public property Parent Gets the parent object for the Microsoft.Office.Tools.Excel.ChartSheet.
Public property Perspective Gets or sets the perspective for the 3-D Microsoft.Office.Tools.Excel.ChartSheet.
Public property Pie3DGroup Gets a ChartGroup that represents the pie chart group on a 3-D Microsoft.Office.Tools.Excel.ChartSheet.
Public property PivotLayout Gets a PivotLayout that represents the placement of fields in a PivotTable report and the placement of axes in a PivotChart report.
Public property PlotArea Gets a PlotArea object that represents the plot area of a Microsoft.Office.Tools.Excel.ChartSheet.
Public property PlotBy Gets or sets the way columns or rows are used as data series on the Microsoft.Office.Tools.Excel.ChartSheet.
Public property PlotVisibleOnly Gets or sets a value that indicates whether only visible cells are plotted.
Public property Previous Gets a Worksheet object that represents the previous sheet.
Public property PrintedCommentPages Gets the number of comment pages that will be printed for the current chart sheet.
Public property ProtectContents Gets a value that indicates whether the contents of the Microsoft.Office.Tools.Excel.ChartSheet are protected.
Public property ProtectData Gets or sets a value that indicates whether series formulas cannot be modified by the user.
Public property ProtectDrawingObjects Gets a value that indicates whether shapes are protected on the Microsoft.Office.Tools.Excel.ChartSheet.
Public property ProtectFormatting Gets or sets a value that indicates whether Microsoft.Office.Tools.Excel.ChartSheet formatting cannot be modified by the user.
Public property ProtectGoalSeek Gets or sets a value that indicates whether the user cannot modify chart data points with mouse actions.
Public property ProtectionMode Gets or sets a value that indicates whether user-interface-only protection is turned on.
Public property ProtectSelection Gets or sets a value that indicates whether Microsoft.Office.Tools.Excel.ChartSheet elements cannot be selected.
Public property RightAngleAxes Gets or sets a value that indicates whether the Microsoft.Office.Tools.Excel.ChartSheet axes are at right angles, independent of chart rotation or elevation.
Public property Rotation Gets or sets the rotation of the 3-D Microsoft.Office.Tools.Excel.ChartSheet.
Public property Scripts Gets the Scripts collection, which contains Script objects representing blocks of script or code in the specified document when it is saved as a Web page.
Public property Shapes Gets a Shapes object that represents all the shapes on the Microsoft.Office.Tools.Excel.ChartSheet.
Public property ShowAllFieldButtons Gets or sets whether to display all field buttons on a PivotChart that is displayed on the ChartSheet.
Public property ShowAxisFieldButtons Gets or sets whether to display axis field buttons on a PivotChart that is displayed on the ChartSheet.
Public property ShowDataLabelsOverMaximum Gets or sets a value that indicates whether to show the data labels when the value is greater than the maximum value on the value axis.
Public property ShowLegendFieldButtons Gets or sets whether to display legend field buttons on a PivotChart that is displayed on the ChartSheet.
Public property ShowReportFilterFieldButtons Gets or sets whether to display the report filter field buttons on a PivotChart that is displayed on the ChartSheet.
Public property ShowValueFieldButtons Gets or sets whether to display the value field buttons on a PivotChart that is displayed on the ChartSheet.
Public property SideWall Gets an object that represents the side wall of a 3-D chart.
Public property Site Gets or sets the ISite associated with the IComponent. (Inherited from IComponent.)
Public property SubType Infrastructure.
Public property SurfaceGroup Gets a ChartGroup object that represents the surface chart group of a 3-D Microsoft.Office.Tools.Excel.ChartSheet.
Public property Tab Gets a Tab object for a Microsoft.Office.Tools.Excel.ChartSheet.
Public property Tag Gets or sets the object that contains data about the ChartSheet.
Public property Type Infrastructure.
Public property Visible Determines whether the object is visible.
Public property Walls Gets a Walls object that represents the walls of the 3-D Microsoft.Office.Tools.Excel.ChartSheet.
Public property WallsAndGridlines2D Gets or sets a value that indicates whether gridlines are drawn two-dimensionally on a 3-D Microsoft.Office.Tools.Excel.ChartSheet.

Top

Methods

  Name Description
Public method _ApplyDataLabels Infrastructure.
Public method _Dummy23 Infrastructure.
Public method _Evaluate Infrastructure.
Public method _PrintOut Infrastructure.
Public method _Protect Infrastructure.
Public method _SaveAs Infrastructure.
Public method _VtblGap1_1 Infrastructure.
Public method _VtblGap2_1 Infrastructure.
Public method _VtblGap3_1 Infrastructure.
Public method _VtblGap4_2 Infrastructure.
Public method _VtblGap5_1 Infrastructure.
Public method _VtblGap6_1 Infrastructure.
Public method Activate Makes the current Microsoft.Office.Tools.Excel.ChartSheet the active chart.
Public method ApplyChartTemplate Applies a standard or custom chart template to the chart.
Public method ApplyCustomType Applies a standard or custom chart type to a Microsoft.Office.Tools.Excel.ChartSheet.
Public method ApplyDataLabels Applies data labels to a point, a series, or all the series in a Microsoft.Office.Tools.Excel.ChartSheet.
Public method ApplyLayout Applies the specified layout to the chart.
Public method Arcs Infrastructure.
Public method AreaGroups 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).
Public method AutoFormat Infrastructure.
Public method Axes Gets an object that represents either a single axis or a collection of the axes on the chart.
Public method BarGroups 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).
Public method BeginInit Signals the object that initialization is starting. (Inherited from ISupportInitialize.)
Public method Buttons Infrastructure.
Public method ChartGroups Gets 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).
Public method ChartObjects Gets 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.
Public method ChartWizard Modifies the properties of the given Microsoft.Office.Tools.Excel.ChartSheet.
Public method CheckBoxes Infrastructure.
Public method CheckSpelling Checks the spelling of an Microsoft.Office.Tools.Excel.ChartSheet.
Public method ClearToMatchStyle Clears the chart elements formatting to automatic.
Public method ColumnGroups 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).
Public method Copy Copies the Microsoft.Office.Tools.Excel.ChartSheet to another location in the workbook.
Public method CopyChartBuild Infrastructure.
Public method CopyPicture Copies the Microsoft.Office.Tools.Excel.ChartSheet to the Clipboard as a picture.
Public method CreatePublisher Infrastructure.
Public method Delete Deletes the Chart object.
Public method Deselect Cancels the selection for the specified Microsoft.Office.Tools.Excel.ChartSheet.
Public method Dispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
Public method DoughnutGroups On a 2-D Microsoft.Office.Tools.Excel.ChartSheet, 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).
Public method DrawingObjects Infrastructure.
Public method Drawings Infrastructure.
Public method DropDowns Infrastructure.
Public method EndInit Signals the object that initialization is complete. (Inherited from ISupportInitialize.)
Public method Evaluate Converts a Microsoft Office Excel name to an object or a value.
Public method Export Exports the Microsoft.Office.Tools.Excel.ChartSheet in a graphic format.
Public method ExportAsFixedFormat Saves the chart that is displayed on the ChartSheet in PDF or XPS format.
Public method get_HasAxis Infrastructure.
Public method GetChartElement Gets information about the chart element at specified X and Y coordinates.
Public method GroupBoxes Infrastructure.
Public method GroupObjects Infrastructure.
Public method Labels Infrastructure.
Public method LineGroups 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).
Public method Lines Infrastructure.
Public method ListBoxes Infrastructure.
Public method Location Moves the Microsoft.Office.Tools.Excel.ChartSheet to a new location.
Public method Move Moves the Microsoft.Office.Tools.Excel.ChartSheet to another location in the workbook.
Public method OLEObjects Gets 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.
Public method OptionButtons Infrastructure.
Public method Ovals Infrastructure.
Public method Paste Pastes chart data from the Clipboard into the specified Microsoft.Office.Tools.Excel.ChartSheet.
Public method Pictures Infrastructure.
Public method PieGroups On a 2-D Microsoft.Office.Tools.Excel.ChartSheet, 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).
Public method PrintOut Prints the Microsoft.Office.Tools.Excel.ChartSheet.
Public method PrintOutEx Prints the chart that is displayed on the ChartSheet.
Public method PrintPreview Shows a preview of the Microsoft.Office.Tools.Excel.ChartSheet as it would look when printed.
Public method Protect Protects a Microsoft.Office.Tools.Excel.ChartSheet so that it cannot be modified.
Public method RadarGroups On a 2-D Microsoft.Office.Tools.Excel.ChartSheet, 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).
Public method Rectangles Infrastructure.
Public method Refresh Updates the cache of the Microsoft.Office.Tools.Excel.ChartSheet.
Public method SaveAs Saves changes to the Microsoft.Office.Tools.Excel.ChartSheet in a different file.
Public method SaveChartTemplate Saves the chart on the ChartSheet as a custom template in the list of available chart templates.
Public method ScrollBars Infrastructure.
Public method Select Selects the Microsoft.Office.Tools.Excel.ChartSheet.
Public method SeriesCollection Gets 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.
Public method set_HasAxis Infrastructure.
Public method SetBackgroundPicture Sets the background graphic for a Microsoft.Office.Tools.Excel.ChartSheet.
Public method SetDefaultChart Specifies the name of the chart template that Microsoft Office Excel uses when creating new charts.
Public method SetElement Modifies an element on the chart that is displayed on the ChartSheet.
Public method SetSourceData Sets the source data range for the Microsoft.Office.Tools.Excel.ChartSheet.
Public method Spinners Infrastructure.
Public method TextBoxes Infrastructure.
Public method Unprotect Removes protection from a Microsoft.Office.Tools.Excel.ChartSheet. This method has no effect if the sheet or workbook is not protected.
Public method XYGroups On a 2-D Microsoft.Office.Tools.Excel.ChartSheet, 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).

Top

Events

  Name Description
Public event ActivateEvent Occurs when the Microsoft.Office.Tools.Excel.ChartSheet is activated.
Public event BeforeDoubleClick Occurs when the Microsoft.Office.Tools.Excel.ChartSheet is double-clicked, before the default double-click action.
Public event BeforeRightClick Occurs when the Microsoft.Office.Tools.Excel.ChartSheet is right-clicked, before the default right-click action.
Public event BindingContextChanged Infrastructure.
Public event Calculate Occurs after the Microsoft.Office.Tools.Excel.ChartSheet plots new or changed data.
Public event Deactivate Occurs when the selection moves away from the Microsoft.Office.Tools.Excel.ChartSheet, causing the Microsoft.Office.Tools.Excel.ChartSheet to become deactivated.
Public event Disposed Represents the method that handles the Disposed event of a component. (Inherited from IComponent.)
Public event MouseDown Occurs when a mouse button is pressed when the pointer is over a Microsoft.Office.Tools.Excel.ChartSheet.
Public event MouseMove Occurs when the position of the mouse pointer changes over the Microsoft.Office.Tools.Excel.ChartSheet.
Public event MouseUp Occurs when a mouse button is released when the pointer is over the Microsoft.Office.Tools.Excel.ChartSheet.
Public event Resize Occurs when the size of the Microsoft.Office.Tools.Excel.ChartSheet is changed.
Public event SelectEvent Occurs when the Microsoft.Office.Tools.Excel.ChartSheet is selected.
Public event SeriesChange Occurs when the value of a Microsoft.Office.Tools.Excel.ChartSheet data point is changed.
Public event Shutdown Occurs when the application domain for the assembly is about to unload.
Public event Startup Occurs after the document is running and all the initialization code in the assembly has been run.

Top

Remarks

A ChartSheet represents a chart sheet; that is, a worksheet that contains only a chart. If you want to create an embedded chart in a worksheet that also contains other items, such as cells or other controls, create a Chart instead.

A ChartSheet provides all the chart-related features of a native Chart object in the Excel object model. However, a ChartSheet also exposes events. You can create ChartSheet objects only in a document-level project at design time.

Note

This interface is implemented by the Visual Studio Tools for Office runtime. It is not intended to be implemented in your code. For more information, see Visual Studio Tools for Office Runtime Overview.

Usage

This documentation describes the version of this type that is used in Office projects that target the .NET Framework 4 and the .NET Framework 4.5. In projects that target the .NET Framework 3.5, this type might have different members and the code examples provided for this type might not work. For documentation about this type in projects that target the .NET Framework 3.5, see the following reference section in the Visual Studio 2008 documentation: https://go.microsoft.com/fwlink/?LinkId=160658.

See Also

Reference

Microsoft.Office.Tools.Excel Namespace

Other Resources

Host Items and Host Controls Overview

ChartSheet Host Item