ChartSheetBase Class

Definition

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

[System.ComponentModel.ToolboxItem(false)]
public abstract class ChartSheetBase : IDisposable, Microsoft.Office.Tools.Excel.IChartSheetExtension, System.ComponentModel.IComponent, System.ComponentModel.ISupportInitialize, System.Windows.Forms.IBindableComponent
Inheritance
ChartSheetBase
Attributes
Implements

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 or later. 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.

Constructors

ChartSheetBase(Factory, IServiceProvider, String, String)

Properties

Application

Gets an Application that represents the Microsoft Office Excel application.

AutoScaling

Gets a value that indicates whether Microsoft Office Excel scales a 3-D 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.

BarShape

Gets or sets the shape used with the 3-D bar or column ChartSheetBase.

Base

Gets the ChartSheet object that this ChartSheetBase object extends.

BindingContext
ChartArea

Gets a ChartArea that represents the complete chart area for the ChartSheetBase.

ChartStyle

Gets or sets the style of the chart.

ChartTitle

Gets a ChartTitle that represents the title of the specified ChartSheetBase.

ChartType

Gets or sets the ChartSheetBase type.

Creator

Gets an XlCreator code that indicates the application in which the ChartSheetBase was created.

DataBindings
DataHost
DataTable

Gets a DataTable object that represents the ChartSheetBase data table.

DepthPercent

Gets or sets the depth of a 3-D chart as a percentage of the ChartSheetBase width.

DisplayBlanksAs

Gets or sets the way that blank cells are plotted on a ChartSheetBase.

Elevation

Gets or sets the elevation of the 3-D ChartSheetBase, in degrees.

Floor

Gets a Floor object that represents the floor of the 3-D ChartSheetBase.

GapDepth

Gets or sets the distance between the data series in a 3-D ChartSheetBase, as a percentage of the marker width.

HasAxis

Gets or sets a value indicating whether a specific axis exists on the ChartSheetBase.

HasDataTable

Gets or sets a value that indicates whether the ChartSheetBase has a data table.

HasLegend

Gets or sets a value that indicates whether the ChartSheetBase has a legend.

HasTitle

Gets or sets a value the indicates whether the ChartSheetBase has a visible title.

HeightPercent

Gets or sets the height of a 3-D chart as a percentage of the ChartSheetBase width.

HostContext
Hyperlinks

Gets a Hyperlinks collection that represents the hyperlinks for the ChartSheetBase.

Index

Gets the index number of the ChartSheetBase.

InnerObject

Gets a Chart that represents the underlying native object for the ChartSheetBase.

ItemProvider
Legend

Gets a Legend that represents the legend for the ChartSheetBase.

MailEnvelope

Represents an e-mail header for a document.

Name

Gets or sets the name of the ChartSheetBase.

Next

Gets a Worksheet object that represents the next sheet.

PageSetup

Gets a PageSetup that contains all the page setup settings for the ChartSheetBase.

Parent

Gets the parent object for the ChartSheetBase.

Perspective

Gets or sets the perspective for the 3-D 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 ChartSheetBase.

PlotBy

Gets or sets the way columns or rows are used as data series on the 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 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 ChartSheetBase.

ProtectFormatting

Gets or sets a value that indicates whether ChartSheetBase formatting cannot be modified by the user.

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 ChartSheetBase elements cannot be selected.

RightAngleAxes

Gets or sets a value that indicates whether the ChartSheetBase axes are at right angles, independent of chart rotation or elevation.

Rotation

Gets or sets the rotation of the 3-D ChartSheetBase.

Shapes

Gets a Shapes object that represents all the shapes on the 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
Tab

Gets a Tab object for a ChartSheetBase.

Tag

Gets or sets the object that contains data about the ChartSheetBase.

Visible

Determines whether the object is visible.

Walls

Gets a Walls object that represents the walls of the 3-D ChartSheetBase.

Methods

Activate()

Makes the current ChartSheetBase the active chart.

ApplyChartTemplate(String)

Applies a standard or custom chart template to the 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 ChartSheetBase.

ApplyLayout(Int32, Object)

Applies the specified layout to the chart.

Axes(Object, XlAxisGroup)

Gets an object that represents either a single axis or a collection of the axes on the chart.

BeginInit()
ChartGroups(Object)

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(Object)

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(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object)

Modifies the properties of the given ChartSheetBase.

CheckSpelling(Object, Object, Object, Object)

Checks the spelling of an ChartSheetBase.

ClearToMatchStyle()

Clears the chart elements formatting to automatic.

Copy(Object, Object)

Copies the ChartSheetBase to another location in the workbook.

CopyPicture(XlPictureAppearance, XlCopyPictureFormat, XlPictureAppearance)

Copies the ChartSheetBase to the Clipboard as a picture.

Delete()

Deletes the Chart object.

Dispose()

Releases all resources used by the current instance of the ChartSheetBase class.

EndInit()
Evaluate(Object)

Converts a Microsoft Office Excel name to an object or a value.

Export(String, Object, Object)

Exports the ChartSheetBase in a graphic format.

ExportAsFixedFormat(XlFixedFormatType, Object, Object, Object, Object, Object, Object, Object, Object)

Saves the chart that is displayed on the ChartSheetBase in PDF or XPS format.

FinishInitialization()
GetAutomationObject()
GetChartElement(Int32, Int32, Int32, Int32, Int32)

Gets information about the chart element at specified X and Y coordinates.

Initialize()
InitializeDataBindings()
Location(XlChartLocation, Object)

Moves the ChartSheetBase to a new location.

Move(Object, Object)

Moves the ChartSheetBase to another location in the workbook.

OLEObjects(Object)

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()
OnStartup()
Paste(Object)

Pastes chart data from the Clipboard into the specified ChartSheetBase.

PrintOutEx(Object, Object, Object, Object, Object, Object, Object, Object)

Prints the chart that is displayed on the ChartSheetBase.

PrintPreview(Object)

Shows a preview of the ChartSheetBase as it would look when printed.

Protect(Object, Object, Object, Object, Object)

Protects a ChartSheetBase so that it cannot be modified.

Refresh()

Updates the cache of the ChartSheetBase.

SaveAs(String, Object, Object, Object, Object, Object, Object, Object, Object, Object)

Saves changes to the ChartSheetBase in a different file.

SaveChartTemplate(String)

Saves the chart on the ChartSheetBase as a custom template in the list of available chart templates.

Select(Object)

Selects the ChartSheetBase.

SeriesCollection(Object)

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.

SetBackgroundPicture(String)

Sets the background graphic for a ChartSheetBase.

SetDefaultChart(Object)

Specifies the name of the chart template that Microsoft Office Excel uses when creating new charts.

SetElement(MsoChartElementType)

Modifies an element on the chart that is displayed on the ChartSheetBase.

SetSourceData(Range, Object)

Sets the source data range for the ChartSheetBase.

Unprotect(Object)

Removes protection from a ChartSheetBase. This method has no effect if the sheet or workbook is not protected.

Events

ActivateEvent

Occurs when the ChartSheetBase is activated.

BeforeDoubleClick

Occurs when the ChartSheetBase is double-clicked, before the default double-click action.

BeforeRightClick

Occurs when the ChartSheetBase is right-clicked, before the default right-click action.

BindingContextChanged
Calculate

Occurs after the ChartSheetBase plots new or changed data.

Deactivate

Occurs when the selection moves away from the ChartSheetBase, causing the ChartSheetBase to become deactivated.

Disposed
MouseDown

Occurs when a mouse button is pressed when the pointer is over a ChartSheetBase.

MouseMove

Occurs when the position of the mouse pointer changes over the ChartSheetBase.

MouseUp

Occurs when a mouse button is released when the pointer is over the ChartSheetBase.

Resize

Occurs when the size of the ChartSheetBase is changed.

SelectEvent

Occurs when the ChartSheetBase is selected.

SeriesChange

Occurs when the value of a 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.

Explicit Interface Implementations

EntryPoint.BeginInit()
EntryPoint.EndInit()
EntryPoint.FinishInitialization()
EntryPoint.Initialize()
EntryPoint.InitializeDataBindings()
EntryPoint.OnShutdown()
EntryPoint.OnStartup()
IChartSheetExtension.GetAutomationObject()
IExtension.ExtensionBase

Applies to