ChartSheet Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents a worksheet in document-level Excel projects created by using the Office development tools in Visual Studio.
public interface class ChartSheet : IDisposable, System::ComponentModel::IComponent, System::ComponentModel::ISupportInitialize, System::Windows::Forms::IBindableComponent
[System.Runtime.InteropServices.Guid("0bc69504-5797-4291-8178-cef15cc18b98")]
public interface ChartSheet : IDisposable, System.ComponentModel.IComponent, System.ComponentModel.ISupportInitialize, System.Windows.Forms.IBindableComponent
[<System.Runtime.InteropServices.Guid("0bc69504-5797-4291-8178-cef15cc18b98")>]
type ChartSheet = interface
interface IBindableComponent
interface IComponent
interface IDisposable
interface ISupportInitialize
Public Interface ChartSheet
Implements IBindableComponent, IComponent, IDisposable, ISupportInitialize
- Attributes
- Implements
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 Microsoft.Office.Interop.Excel.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 or later. 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: http://go.microsoft.com/fwlink/?LinkId=160658.
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 ChartSheet 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 ChartSheet. |
ChartArea |
Gets a ChartArea that represents the complete chart area for the ChartSheet. |
ChartStyle |
Gets or sets the style of the chart. |
ChartTitle |
Gets a ChartTitle that represents the title of the specified ChartSheet. |
ChartType |
Gets or sets the ChartSheet type. |
Creator |
Gets an XlCreator code that indicates the application in which the ChartSheet was created. |
DataHost | |
DataTable |
Gets a DataTable object that represents the ChartSheet data table. |
DefaultExtension |
Gets the default extension for this ChartSheet object. |
DepthPercent |
Gets or sets the depth of a 3-D chart as a percentage of the ChartSheet width. |
DisplayBlanksAs |
Gets or sets the way that blank cells are plotted on a ChartSheet. |
Elevation |
Gets or sets the elevation of the 3-D ChartSheet, in degrees. |
Extension |
Gets a custom extension for this ChartSheet object. |
Floor |
Gets a Floor object that represents the floor of the 3-D ChartSheet. |
GapDepth |
Gets or sets the distance between the data series in a 3-D ChartSheet, as a percentage of the marker width. |
HasAxis |
Gets or sets a value indicating whether a specific axis exists on the ChartSheet. |
HasDataTable |
Gets or sets a value that indicates whether the ChartSheet has a data table. |
HasLegend |
Gets or sets a value that indicates whether the ChartSheet has a legend. |
HasTitle |
Gets or sets a value the indicates whether the ChartSheet has a visible title. |
HeightPercent |
Gets or sets the height of a 3-D chart as a percentage of the ChartSheet width. |
HostContext | |
Hyperlinks |
Gets a Hyperlinks collection that represents the hyperlinks for the ChartSheet. |
Index |
Gets the index number of the ChartSheet. |
InnerObject |
Gets a Chart that represents the underlying native object for the ChartSheet. |
ItemProvider | |
Legend |
Gets a Legend that represents the legend for the ChartSheet. |
MailEnvelope |
Represents an e-mail header for a document. |
Name |
Gets or sets the name of the ChartSheet. |
Next |
Gets a Worksheet object that represents the next sheet. |
PageSetup |
Gets a PageSetup that contains all the page setup settings for the ChartSheet. |
Parent |
Gets the parent object for the ChartSheet. |
Perspective |
Gets or sets the perspective for the 3-D ChartSheet. |
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 ChartSheet. |
PlotBy |
Gets or sets the way columns or rows are used as data series on the ChartSheet. |
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. |
ProtectContents |
Gets a value that indicates whether the contents of the ChartSheet 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 ChartSheet. |
ProtectFormatting |
Gets or sets a value that indicates whether ChartSheet 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 ChartSheet elements cannot be selected. |
RightAngleAxes |
Gets or sets a value that indicates whether the ChartSheet axes are at right angles, independent of chart rotation or elevation. |
Rotation |
Gets or sets the rotation of the 3-D ChartSheet. |
Shapes |
Gets a Shapes object that represents all the shapes on the ChartSheet. |
ShowAllFieldButtons |
Gets or sets whether to display all field buttons on a PivotChart that is displayed on the ChartSheet. |
ShowAxisFieldButtons |
Gets or sets whether to display axis field buttons on a PivotChart that is displayed on the ChartSheet. |
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 ChartSheet. |
ShowReportFilterFieldButtons |
Gets or sets whether to display the report filter field buttons on a PivotChart that is displayed on the ChartSheet. |
ShowValueFieldButtons |
Gets or sets whether to display the value field buttons on a PivotChart that is displayed on the ChartSheet. |
SideWall |
Gets an object that represents the side wall of a 3-D chart. |
Tab |
Gets a Tab object for a ChartSheet. |
Tag |
Gets or sets the object that contains data about the ChartSheet. |
Visible |
Determines whether the object is visible. |
Walls |
Gets a Walls object that represents the walls of the 3-D ChartSheet. |
Methods
Activate() |
Makes the current ChartSheet 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 ChartSheet. |
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. |
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 ChartSheet. |
CheckSpelling(Object, Object, Object, Object) |
Checks the spelling of an ChartSheet. |
ClearToMatchStyle() |
Clears the chart elements formatting to automatic. |
Copy(Object, Object) |
Copies the ChartSheet to another location in the workbook. |
CopyPicture(XlPictureAppearance, XlCopyPictureFormat, XlPictureAppearance) |
Copies the ChartSheet to the Clipboard as a picture. |
Delete() |
Deletes the Chart object. |
Evaluate(Object) |
Converts a Microsoft Office Excel name to an object or a value. |
Export(String, Object, Object) |
Exports the ChartSheet in a graphic format. |
ExportAsFixedFormat(XlFixedFormatType, Object, Object, Object, Object, Object, Object, Object, Object) |
Saves the chart that is displayed on the ChartSheet in PDF or XPS format. |
GetChartElement(Int32, Int32, Int32, Int32, Int32) |
Gets information about the chart element at specified X and Y coordinates. |
Location(XlChartLocation, Object) |
Moves the ChartSheet to a new location. |
Move(Object, Object) |
Moves the ChartSheet 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. |
Paste(Object) |
Pastes chart data from the Clipboard into the specified ChartSheet. |
PrintOutEx(Object, Object, Object, Object, Object, Object, Object, Object) |
Prints the chart that is displayed on the ChartSheet. |
PrintPreview(Object) |
Shows a preview of the ChartSheet as it would look when printed. |
Protect(Object, Object, Object, Object, Object) |
Protects a ChartSheet so that it cannot be modified. |
Refresh() |
Updates the cache of the ChartSheet. |
SaveAs(String, Object, Object, Object, Object, Object, Object, Object, Object, Object) |
Saves changes to the ChartSheet in a different file. |
SaveChartTemplate(String) |
Saves the chart on the ChartSheet as a custom template in the list of available chart templates. |
Select(Object) |
Selects the ChartSheet. |
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 ChartSheet. |
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 ChartSheet. |
SetSourceData(Range, Object) |
Sets the source data range for the ChartSheet. |
Unprotect(Object) |
Removes protection from a ChartSheet. This method has no effect if the sheet or workbook is not protected. |
Events
ActivateEvent |
Occurs when the ChartSheet is activated. |
BeforeDoubleClick |
Occurs when the ChartSheet is double-clicked, before the default double-click action. |
BeforeRightClick |
Occurs when the ChartSheet is right-clicked, before the default right-click action. |
BindingContextChanged | |
Calculate |
Occurs after the ChartSheet plots new or changed data. |
Deactivate |
Occurs when the selection moves away from the ChartSheet, causing the ChartSheet to become deactivated. |
MouseDown |
Occurs when a mouse button is pressed when the pointer is over a ChartSheet. |
MouseMove |
Occurs when the position of the mouse pointer changes over the ChartSheet. |
MouseUp |
Occurs when a mouse button is released when the pointer is over the ChartSheet. |
Resize |
Occurs when the size of the ChartSheet is changed. |
SelectEvent |
Occurs when the ChartSheet is selected. |
SeriesChange |
Occurs when the value of a ChartSheet 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. |