Partager via

ChartSheetBase Class

  • Article

Provides the base class for chart sheet host items in document-level Office projects for Microsoft Office Excel.

Inheritance Hierarchy

System.Object
  Microsoft.Office.Tools.Excel.ChartSheetBase

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

Syntax

'Declaration
Public MustInherit Class ChartSheetBase _
    Implements IChartSheetExtension, IExtension, EntryPoint, ISupportInitialize,  _
    IBindableComponent, IComponent, IDisposable

public abstract class ChartSheetBase : IChartSheetExtension, 
    IExtension, EntryPoint, ISupportInitialize, IBindableComponent, IComponent, 
    IDisposable

The ChartSheetBase type exposes the following members.

Constructors

  Name Description
Protected method ChartSheetBase Infrastructure.

Top

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.ChartSheetBase.
Public property AutoScaling Gets a value that indicates whether Microsoft Office Excel scales a 3-D Microsoft.Office.Tools.Excel.ChartSheetBase 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.ChartSheetBase.
Public property BarShape Gets or sets the shape used with the 3-D bar or column Microsoft.Office.Tools.Excel.ChartSheetBase.
Public property Base Gets the ChartSheet object that this ChartSheetBase object extends.
Public property BindingContext Infrastructure.
Public property ChartArea Gets a ChartArea that represents the complete chart area for the Microsoft.Office.Tools.Excel.ChartSheetBase.
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.ChartSheetBase.
Public property ChartType Gets or sets the Microsoft.Office.Tools.Excel.ChartSheetBase 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.ChartSheetBase.
Public property Corners Gets a Corners object that represents the corners of a 3-D Microsoft.Office.Tools.Excel.ChartSheetBase.
Public property Creator Gets an XlCreator code that indicates the application in which the Microsoft.Office.Tools.Excel.ChartSheetBase was created.
Public property DataBindings Infrastructure.
Public property DataHost Infrastructure.
Public property DataTable Gets a DataTable object that represents the Microsoft.Office.Tools.Excel.ChartSheetBase data table.
Public property DepthPercent Gets or sets the depth of a 3-D chart as a percentage of the Microsoft.Office.Tools.Excel.ChartSheetBase width.
Public property DisplayBlanksAs Gets or sets the way that blank cells are plotted on a Microsoft.Office.Tools.Excel.ChartSheetBase.
Public property Dummy24 Infrastructure.
Public property Dummy25 Infrastructure.
Public property Elevation Gets or sets the elevation of the 3-D Microsoft.Office.Tools.Excel.ChartSheetBase, in degrees.
Public property Floor Gets a Floor object that represents the floor of the 3-D Microsoft.Office.Tools.Excel.ChartSheetBase.
Public property GapDepth Gets or sets the distance between the data series in a 3-D Microsoft.Office.Tools.Excel.ChartSheetBase, 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.ChartSheetBase.
Public property HasDataTable Gets or sets a value that indicates whether the Microsoft.Office.Tools.Excel.ChartSheetBase has a data table.
Public property HasLegend Gets or sets a value that indicates whether the Microsoft.Office.Tools.Excel.ChartSheetBase 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.ChartSheetBase 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.ChartSheetBase width.
Public property HostContext Infrastructure.
Public property Hyperlinks Gets a Hyperlinks collection that represents the hyperlinks for the Microsoft.Office.Tools.Excel.ChartSheetBase.
Public property Index Gets the index number of the Microsoft.Office.Tools.Excel.ChartSheetBase.
Public property InnerObject Gets a Microsoft.Office.Interop.Excel.Chart that represents the underlying native object for the ChartSheetBase.
Public property ItemProvider Infrastructure.
Public property Legend Gets a Legend that represents the legend for the Microsoft.Office.Tools.Excel.ChartSheetBase.
Public property Line3DGroup Gets a ChartGroup that represents the line chart group on a 3-D Microsoft.Office.Tools.Excel.ChartSheetBase.
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.ChartSheetBase.
Public property Next Gets a Microsoft.Office.Interop.Excel.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.ChartSheetBase.
Public property Parent Gets the parent object for the Microsoft.Office.Tools.Excel.ChartSheetBase.
Public property Perspective Gets or sets the perspective for the 3-D Microsoft.Office.Tools.Excel.ChartSheetBase.
Public property Pie3DGroup Gets a ChartGroup that represents the pie chart group on a 3-D Microsoft.Office.Tools.Excel.ChartSheetBase.
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.ChartSheetBase.
Public property PlotBy Gets or sets the way columns or rows are used as data series on the Microsoft.Office.Tools.Excel.ChartSheetBase.
Public property PlotVisibleOnly Gets or sets a value that indicates whether only visible cells are plotted.
Public property Previous Gets a Microsoft.Office.Interop.Excel.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. This property can be used only in Excel 2010 projects.
Public property ProtectContents Gets a value that indicates whether the contents of the Microsoft.Office.Tools.Excel.ChartSheetBase 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.ChartSheetBase.
Public property ProtectFormatting Gets or sets a value that indicates whether Microsoft.Office.Tools.Excel.ChartSheetBase 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.ChartSheetBase elements cannot be selected.
Public property RightAngleAxes Gets or sets a value that indicates whether the Microsoft.Office.Tools.Excel.ChartSheetBase 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.ChartSheetBase.
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.ChartSheetBase.
Public property ShowAllFieldButtons Gets or sets whether to display all field buttons on a PivotChart that is displayed on the ChartSheetBase. This property can be used only in Excel 2010 projects.
Public property ShowAxisFieldButtons Gets or sets whether to display axis field buttons on a PivotChart that is displayed on the ChartSheetBase. This property can be used only in Excel 2010 projects.
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 ChartSheetBase. This property can be used only in Excel 2010 projects.
Public property ShowReportFilterFieldButtons Gets or sets whether to display the report filter field buttons on a PivotChart that is displayed on the ChartSheetBase. This property can be used only in Excel 2010 projects.
Public property ShowValueFieldButtons Gets or sets whether to display the value field buttons on a PivotChart that is displayed on the ChartSheetBase. This property can be used only in Excel 2010 projects.
Public property SideWall Gets an object that represents the side wall of a 3-D chart.
Public property Site Infrastructure.
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.ChartSheetBase.
Public property Tab Gets a Tab object for a Microsoft.Office.Tools.Excel.ChartSheetBase.
Public property Tag Gets or sets the object that contains data about the ChartSheetBase.
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.ChartSheetBase.
Public property WallsAndGridlines2D Gets or sets a value that indicates whether gridlines are drawn two-dimensionally on a 3-D Microsoft.Office.Tools.Excel.ChartSheetBase.

Top

Methods

  Name Description
Public method Activate Makes the current Microsoft.Office.Tools.Excel.ChartSheetBase 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.ChartSheetBase.
Public method ApplyDataLabels Applies data labels to a point, a series, or all the series in a Microsoft.Office.Tools.Excel.ChartSheetBase.
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 Infrastructure.
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.ChartSheetBase.
Public method CheckBoxes Infrastructure.
Public method CheckSpelling Checks the spelling of an Microsoft.Office.Tools.Excel.ChartSheetBase.
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.ChartSheetBase to another location in the workbook.
Public method CopyChartBuild Infrastructure.
Public method CopyPicture Copies the Microsoft.Office.Tools.Excel.ChartSheetBase to the Clipboard as a picture.
Public method CreatePublisher Infrastructure.
Public method Delete Deletes the Microsoft.Office.Interop.Excel.Chart object.
Public method Deselect Cancels the selection for the specified Microsoft.Office.Tools.Excel.ChartSheetBase.
Public method Dispose Releases all resources used by the current instance of the ChartSheetBase class.
Public method DoughnutGroups On a 2-D Microsoft.Office.Tools.Excel.ChartSheetBase, 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 Infrastructure.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method Evaluate Converts a Microsoft Office Excel name to an object or a value.
Public method Export Exports the Microsoft.Office.Tools.Excel.ChartSheetBase in a graphic format.
Public method ExportAsFixedFormat Saves the chart that is displayed on the ChartSheetBase in PDF or XPS format.
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected method FinishInitialization Infrastructure.
Public method get_HasAxis Infrastructure.
Protected method GetAutomationObject Infrastructure.
Public method GetChartElement Gets information about the chart element at specified X and Y coordinates.
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GroupBoxes Infrastructure.
Public method GroupObjects Infrastructure.
Protected method Initialize Infrastructure.
Protected method InitializeDataBindings 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.ChartSheetBase to a new location.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Move Moves the Microsoft.Office.Tools.Excel.ChartSheetBase 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.
Protected method OnShutdown Infrastructure.
Protected method OnStartup Infrastructure.
Public method OptionButtons Infrastructure.
Public method Ovals Infrastructure.
Public method Paste Pastes chart data from the Clipboard into the specified Microsoft.Office.Tools.Excel.ChartSheetBase.
Public method Pictures Infrastructure.
Public method PieGroups On a 2-D Microsoft.Office.Tools.Excel.ChartSheetBase, 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.ChartSheetBase.
Public method PrintOutEx Prints the chart that is displayed on the ChartSheetBase.
Public method PrintPreview Shows a preview of the Microsoft.Office.Tools.Excel.ChartSheetBase as it would look when printed.
Public method Protect Protects a Microsoft.Office.Tools.Excel.ChartSheetBase so that it cannot be modified.
Public method RadarGroups On a 2-D Microsoft.Office.Tools.Excel.ChartSheetBase, 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.ChartSheetBase.
Public method SaveAs Saves changes to the Microsoft.Office.Tools.Excel.ChartSheetBase in a different file.
Public method SaveChartTemplate Saves the chart on the ChartSheetBase as a custom template in the list of available chart templates.
Public method ScrollBars Infrastructure.
Public method Select Selects the Microsoft.Office.Tools.Excel.ChartSheetBase.
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.ChartSheetBase.
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 ChartSheetBase.
Public method SetSourceData Sets the source data range for the Microsoft.Office.Tools.Excel.ChartSheetBase.
Public method Spinners Infrastructure.
Public method TextBoxes Infrastructure.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method Unprotect Removes protection from a Microsoft.Office.Tools.Excel.ChartSheetBase. This method has no effect if the sheet or workbook is not protected.
Public method XYGroups On a 2-D Microsoft.Office.Tools.Excel.ChartSheetBase, 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.ChartSheetBase is activated.
Public event BeforeDoubleClick Occurs when the Microsoft.Office.Tools.Excel.ChartSheetBase is double-clicked, before the default double-click action.
Public event BeforeRightClick Occurs when the Microsoft.Office.Tools.Excel.ChartSheetBase is right-clicked, before the default right-click action.
Public event BindingContextChanged Infrastructure.
Public event Calculate Occurs after the Microsoft.Office.Tools.Excel.ChartSheetBase plots new or changed data.
Public event Deactivate Occurs when the selection moves away from the Microsoft.Office.Tools.Excel.ChartSheetBase, causing the Microsoft.Office.Tools.Excel.ChartSheetBase to become deactivated.
Public event Disposed Infrastructure.
Public event MouseDown Occurs when a mouse button is pressed when the pointer is over a Microsoft.Office.Tools.Excel.ChartSheetBase.
Public event MouseMove Occurs when the position of the mouse pointer changes over the Microsoft.Office.Tools.Excel.ChartSheetBase.
Public event MouseUp Occurs when a mouse button is released when the pointer is over the Microsoft.Office.Tools.Excel.ChartSheetBase.
Public event Resize Occurs when the size of the Microsoft.Office.Tools.Excel.ChartSheetBase is changed.
Public event SelectEvent Occurs when the Microsoft.Office.Tools.Excel.ChartSheetBase is selected.
Public event SeriesChange Occurs when the value of a Microsoft.Office.Tools.Excel.ChartSheetBase 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

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method EntryPoint.BeginInit Infrastructure.
Explicit interface implemetationPrivate method EntryPoint.EndInit Infrastructure.
Explicit interface implemetationPrivate method EntryPoint.FinishInitialization Infrastructure.
Explicit interface implemetationPrivate method EntryPoint.Initialize Infrastructure.
Explicit interface implemetationPrivate method EntryPoint.InitializeDataBindings Infrastructure.
Explicit interface implemetationPrivate method EntryPoint.OnShutdown Infrastructure.
Explicit interface implemetationPrivate method EntryPoint.OnStartup Infrastructure.
Explicit interface implemetationPrivate method IChartSheetExtension.GetAutomationObject Infrastructure.
Explicit interface implemetationPrivate property IExtension.ExtensionBase Infrastructure.

Top

Remarks

The ChartSheetBase class is the base class for chart sheet host items in document-level Office projects created by using Visual Studio.

A chart sheet 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.

The ChartSheetBase class provides all the chart-related features of a native Microsoft.Office.Interop.Excel.Chart object in the Excel primary interop assembly. However, a ChartSheetBase also exposes events.

Usage

This type is used only in Office projects that target the .NET Framework 4 and the .NET Framework 4.5. The assembly that defines this type is not part of the Visual Studio Tools for Office runtime. You must deploy this assembly with your solution. For more information, see Assemblies in the Visual Studio Tools for Office Runtime.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.Office.Tools.Excel Namespace

Other Resources

Host Items and Host Controls Overview