ChartSheetBase Class

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
	ChartSheetBase	Infrastructure.

Top

Properties

	Name	Description
	_CodeName	Infrastructure.
	Application	Gets an Application that represents the Microsoft Office Excel application.
	Area3DGroup	Gets a ChartGroup that represents the area chart group on a 3-D Microsoft.Office.Tools.Excel.ChartSheetBase.
	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
	BackWall	Gets an object that represents the back wall of a 3-D chart.
	Bar3DGroup	Gets a ChartGroup that represents the bar chart group on a 3-D Microsoft.Office.Tools.Excel.ChartSheetBase.
	BarShape	Gets or sets the shape used with the 3-D bar or column Microsoft.Office.Tools.Excel.ChartSheetBase.
	Base	Gets the ChartSheet object that this ChartSheetBase object extends.
	BindingContext	Infrastructure.
	ChartArea	Gets a ChartArea that represents the complete chart area for the Microsoft.Office.Tools.Excel.ChartSheetBase.
	ChartStyle	Gets or sets the style of the chart.
	ChartTitle	Gets a ChartTitle that represents the title of the specified Microsoft.Office.Tools.Excel.ChartSheetBase.
	ChartType	Gets or sets the Microsoft.Office.Tools.Excel.ChartSheetBase type.
	CodeName	Infrastructure.
	Column3DGroup	Gets a ChartGroup that represents the column chart group on a 3-D Microsoft.Office.Tools.Excel.ChartSheetBase.
	Corners	Gets a Corners object that represents the corners of a 3-D Microsoft.Office.Tools.Excel.ChartSheetBase.
	Creator	Gets an XlCreator code that indicates the application in which the Microsoft.Office.Tools.Excel.ChartSheetBase was created.
	DataBindings	Infrastructure.
	DataHost	Infrastructure.
	DataTable	Gets a DataTable object that represents the Microsoft.Office.Tools.Excel.ChartSheetBase data table.
	DepthPercent	Gets or sets the depth of a 3-D chart as a percentage of the Microsoft.Office.Tools.Excel.ChartSheetBase width.
	DisplayBlanksAs	Gets or sets the way that blank cells are plotted on a Microsoft.Office.Tools.Excel.ChartSheetBase.
	Dummy24	Infrastructure.
	Dummy25	Infrastructure.
	Elevation	Gets or sets the elevation of the 3-D Microsoft.Office.Tools.Excel.ChartSheetBase, in degrees.
	Floor	Gets a Floor object that represents the floor of the 3-D Microsoft.Office.Tools.Excel.ChartSheetBase.
	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.
	HasAxis	Gets or sets a value indicating whether a specific axis exists on the Microsoft.Office.Tools.Excel.ChartSheetBase.
	HasDataTable	Gets or sets a value that indicates whether the Microsoft.Office.Tools.Excel.ChartSheetBase has a data table.
	HasLegend	Gets or sets a value that indicates whether the Microsoft.Office.Tools.Excel.ChartSheetBase has a legend.
	HasPivotFields	Gets or sets a value that indicates whether the PivotChart controls are displayed on the specified PivotChart report.
	HasTitle	Gets or sets a value the indicates whether the Microsoft.Office.Tools.Excel.ChartSheetBase has a visible title.
	HeightPercent	Gets or sets the height of a 3-D chart as a percentage of the Microsoft.Office.Tools.Excel.ChartSheetBase width.
	HostContext	Infrastructure.
	Hyperlinks	Gets a Hyperlinks collection that represents the hyperlinks for the Microsoft.Office.Tools.Excel.ChartSheetBase.
	Index	Gets the index number of the Microsoft.Office.Tools.Excel.ChartSheetBase.
	InnerObject	Gets a Chart that represents the underlying native object for the ChartSheetBase.
	ItemProvider	Infrastructure.
	Legend	Gets a Legend that represents the legend for the Microsoft.Office.Tools.Excel.ChartSheetBase.
	Line3DGroup	Gets a ChartGroup that represents the line chart group on a 3-D Microsoft.Office.Tools.Excel.ChartSheetBase.
	MailEnvelope	Represents an e-mail header for a document.
	Name	Gets or sets the name of the Microsoft.Office.Tools.Excel.ChartSheetBase.
	Next	Gets a Worksheet object that represents the next sheet.
	OnDoubleClick	Infrastructure.
	OnSheetActivate	Infrastructure.
	OnSheetDeactivate	Infrastructure.
	PageSetup	Gets a PageSetup that contains all the page setup settings for the Microsoft.Office.Tools.Excel.ChartSheetBase.
	Parent	Gets the parent object for the Microsoft.Office.Tools.Excel.ChartSheetBase.
	Perspective	Gets or sets the perspective for the 3-D Microsoft.Office.Tools.Excel.ChartSheetBase.
	Pie3DGroup	Gets a ChartGroup that represents the pie chart group on a 3-D Microsoft.Office.Tools.Excel.ChartSheetBase.
	PivotLayout	Gets a PivotLayout that represents the placement of fields in a PivotTable report and the placement of axes in a PivotChart report.
	PlotArea	Gets a PlotArea object that represents the plot area of a Microsoft.Office.Tools.Excel.ChartSheetBase.
	PlotBy	Gets or sets the way columns or rows are used as data series on the Microsoft.Office.Tools.Excel.ChartSheetBase.
	PlotVisibleOnly	Gets or sets a value that indicates whether only visible cells are plotted.
	Previous	Gets a Worksheet object that represents the previous sheet.
	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.
	ProtectContents	Gets a value that indicates whether the contents of the Microsoft.Office.Tools.Excel.ChartSheetBase are protected.
	ProtectData	Gets or sets a value that indicates whether series formulas cannot be modified by the user.
	ProtectDrawingObjects	Gets a value that indicates whether shapes are protected on the Microsoft.Office.Tools.Excel.ChartSheetBase.
	ProtectFormatting	Gets or sets a value that indicates whether Microsoft.Office.Tools.Excel.ChartSheetBase formatting cannot be modified by the user.
	ProtectGoalSeek	Gets or sets a value that indicates whether the user cannot modify chart data points with mouse actions.
	ProtectionMode	Gets or sets a value that indicates whether user-interface-only protection is turned on.
	ProtectSelection	Gets or sets a value that indicates whether Microsoft.Office.Tools.Excel.ChartSheetBase elements cannot be selected.
	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.
	Rotation	Gets or sets the rotation of the 3-D Microsoft.Office.Tools.Excel.ChartSheetBase.
	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.
	Shapes	Gets a Shapes object that represents all the shapes on the Microsoft.Office.Tools.Excel.ChartSheetBase.
	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.
	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.
	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.
	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.
	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.
	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.
	SideWall	Gets an object that represents the side wall of a 3-D chart.
	Site	Infrastructure.
	SubType	Infrastructure.
	SurfaceGroup	Gets a ChartGroup object that represents the surface chart group of a 3-D Microsoft.Office.Tools.Excel.ChartSheetBase.
	Tab	Gets a Tab object for a Microsoft.Office.Tools.Excel.ChartSheetBase.
	Tag	Gets or sets the object that contains data about the ChartSheetBase.
	Type	Infrastructure.
	Visible	Determines whether the object is visible.
	Walls	Gets a Walls object that represents the walls of the 3-D Microsoft.Office.Tools.Excel.ChartSheetBase.
	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
	Activate	Makes the current Microsoft.Office.Tools.Excel.ChartSheetBase the active chart.
	ApplyChartTemplate	Applies a standard or custom chart template to the chart.
	ApplyCustomType	Applies a standard or custom chart type to a Microsoft.Office.Tools.Excel.ChartSheetBase.
	ApplyDataLabels	Applies data labels to a point, a series, or all the series in a Microsoft.Office.Tools.Excel.ChartSheetBase.
	ApplyLayout	Applies the specified layout to the chart.
	Arcs	Infrastructure.
	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).
	AutoFormat	Infrastructure.
	Axes	Gets an object that represents either a single axis or a collection of the axes on the chart.
	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).
	BeginInit	Infrastructure.
	Buttons	Infrastructure.
	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).
	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.
	ChartWizard	Modifies the properties of the given Microsoft.Office.Tools.Excel.ChartSheetBase.
	CheckBoxes	Infrastructure.
	CheckSpelling	Checks the spelling of an Microsoft.Office.Tools.Excel.ChartSheetBase.
	ClearToMatchStyle	Clears the chart elements formatting to automatic.
	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).
	Copy	Copies the Microsoft.Office.Tools.Excel.ChartSheetBase to another location in the workbook.
	CopyChartBuild	Infrastructure.
	CopyPicture	Copies the Microsoft.Office.Tools.Excel.ChartSheetBase to the Clipboard as a picture.
	CreatePublisher	Infrastructure.
	Delete	Deletes the Chart object.
	Deselect	Cancels the selection for the specified Microsoft.Office.Tools.Excel.ChartSheetBase.
	Dispose	Releases all resources used by the current instance of the ChartSheetBase class.
	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).
	DrawingObjects	Infrastructure.
	Drawings	Infrastructure.
	DropDowns	Infrastructure.
	EndInit	Infrastructure.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Evaluate	Converts a Microsoft Office Excel name to an object or a value.
	Export	Exports the Microsoft.Office.Tools.Excel.ChartSheetBase in a graphic format.
	ExportAsFixedFormat	Saves the chart that is displayed on the ChartSheetBase in PDF or XPS format.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FinishInitialization	Infrastructure.
	get_HasAxis	Infrastructure.
	GetAutomationObject	Infrastructure.
	GetChartElement	Gets information about the chart element at specified X and Y coordinates.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GroupBoxes	Infrastructure.
	GroupObjects	Infrastructure.
	Initialize	Infrastructure.
	InitializeDataBindings	Infrastructure.
	Labels	Infrastructure.
	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).
	Lines	Infrastructure.
	ListBoxes	Infrastructure.
	Location	Moves the Microsoft.Office.Tools.Excel.ChartSheetBase to a new location.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Move	Moves the Microsoft.Office.Tools.Excel.ChartSheetBase to another location in the workbook.
	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.
	OnShutdown	Infrastructure.
	OnStartup	Infrastructure.
	OptionButtons	Infrastructure.
	Ovals	Infrastructure.
	Paste	Pastes chart data from the Clipboard into the specified Microsoft.Office.Tools.Excel.ChartSheetBase.
	Pictures	Infrastructure.
	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).
	PrintOut	Prints the Microsoft.Office.Tools.Excel.ChartSheetBase.
	PrintOutEx	Prints the chart that is displayed on the ChartSheetBase.
	PrintPreview	Shows a preview of the Microsoft.Office.Tools.Excel.ChartSheetBase as it would look when printed.
	Protect	Protects a Microsoft.Office.Tools.Excel.ChartSheetBase so that it cannot be modified.
	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).
	Rectangles	Infrastructure.
	Refresh	Updates the cache of the Microsoft.Office.Tools.Excel.ChartSheetBase.
	SaveAs	Saves changes to the Microsoft.Office.Tools.Excel.ChartSheetBase in a different file.
	SaveChartTemplate	Saves the chart on the ChartSheetBase as a custom template in the list of available chart templates.
	ScrollBars	Infrastructure.
	Select	Selects the Microsoft.Office.Tools.Excel.ChartSheetBase.
	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.
	set_HasAxis	Infrastructure.
	SetBackgroundPicture	Sets the background graphic for a Microsoft.Office.Tools.Excel.ChartSheetBase.
	SetDefaultChart	Specifies the name of the chart template that Microsoft Office Excel uses when creating new charts.
	SetElement	Modifies an element on the chart that is displayed on the ChartSheetBase.
	SetSourceData	Sets the source data range for the Microsoft.Office.Tools.Excel.ChartSheetBase.
	Spinners	Infrastructure.
	TextBoxes	Infrastructure.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Unprotect	Removes protection from a Microsoft.Office.Tools.Excel.ChartSheetBase. This method has no effect if the sheet or workbook is not protected.
	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
	ActivateEvent	Occurs when the Microsoft.Office.Tools.Excel.ChartSheetBase is activated.
	BeforeDoubleClick	Occurs when the Microsoft.Office.Tools.Excel.ChartSheetBase is double-clicked, before the default double-click action.
	BeforeRightClick	Occurs when the Microsoft.Office.Tools.Excel.ChartSheetBase is right-clicked, before the default right-click action.
	BindingContextChanged	Infrastructure.
	Calculate	Occurs after the Microsoft.Office.Tools.Excel.ChartSheetBase plots new or changed data.
	Deactivate	Occurs when the selection moves away from the Microsoft.Office.Tools.Excel.ChartSheetBase, causing the Microsoft.Office.Tools.Excel.ChartSheetBase to become deactivated.
	Disposed	Infrastructure.
	MouseDown	Occurs when a mouse button is pressed when the pointer is over a Microsoft.Office.Tools.Excel.ChartSheetBase.
	MouseMove	Occurs when the position of the mouse pointer changes over the Microsoft.Office.Tools.Excel.ChartSheetBase.
	MouseUp	Occurs when a mouse button is released when the pointer is over the Microsoft.Office.Tools.Excel.ChartSheetBase.
	Resize	Occurs when the size of the Microsoft.Office.Tools.Excel.ChartSheetBase is changed.
	SelectEvent	Occurs when the Microsoft.Office.Tools.Excel.ChartSheetBase is selected.
	SeriesChange	Occurs when the value of a Microsoft.Office.Tools.Excel.ChartSheetBase data point is changed.
	Shutdown	Occurs when the application domain for the assembly is about to unload.
	Startup	Occurs after the document is running and all the initialization code in the assembly has been run.

Top

Explicit Interface Implementations

	Name	Description
	EntryPoint.BeginInit	Infrastructure.
	EntryPoint.EndInit	Infrastructure.
	EntryPoint.FinishInitialization	Infrastructure.
	EntryPoint.Initialize	Infrastructure.
	EntryPoint.InitializeDataBindings	Infrastructure.
	EntryPoint.OnShutdown	Infrastructure.
	EntryPoint.OnStartup	Infrastructure.
	IChartSheetExtension.GetAutomationObject	Infrastructure.
	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 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