WorksheetBase Class

Reference

Definition

Namespace:: Microsoft.Office.Tools.Excel

Assembly:: Microsoft.Office.Tools.Excel.v4.0.Utilities.dll

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.

Provides the base class for the Sheetn classes in document-level projects for Microsoft Office Excel.

public ref class WorksheetBase abstract : IDisposable, Microsoft::Office::Tools::Excel::IWorksheetExtension, System::ComponentModel::IComponent, System::ComponentModel::ISupportInitialize, System::Windows::Forms::IBindableComponent

[System.ComponentModel.ToolboxItem(false)]
public abstract class WorksheetBase : IDisposable, Microsoft.Office.Tools.Excel.IWorksheetExtension, System.ComponentModel.IComponent, System.ComponentModel.ISupportInitialize, System.Windows.Forms.IBindableComponent

[<System.ComponentModel.ToolboxItem(false)>]
type WorksheetBase = class
    interface IWorksheetExtension
    interface IExtension
    interface EntryPoint
    interface ISupportInitialize
    interface IBindableComponent
    interface IComponent
    interface IDisposable

Public MustInherit Class WorksheetBase
Implements IBindableComponent, IComponent, IDisposable, ISupportInitialize, IWorksheetExtension

Inheritance: Object
WorksheetBase

Attributes: ToolboxItemAttribute

Implements: EntryPoint IWorksheetExtension IExtension IComponent ISupportInitialize IDisposable IBindableComponent

Remarks

The WorksheetBase class is the base class for the Sheetn classes in document-level Excel projects created by using Visual Studio. Use the Sheetn classes to programmatically access the worksheets in your project. The WorksheetBase class is a host item that represents a worksheet in document-level projects. For more information, see Host Items and Host Controls Overview and Worksheet Host Item.

The WorksheetBase class provides the same members as the Microsoft.Office.Interop.Excel.Worksheet class in the Excel primary interop assembly, but it adds the following features:

Controls property. Use this property to add managed controls to an Excel worksheet, or to remove controls, at run time.
InnerObject property. Use this property to get the underlying Microsoft.Office.Interop.Excel.Worksheet object for a worksheet host item.
GetAutomationObject method. Override this method to expose a class in your project to VBA code in the worksheet.
Document-level events, such as ActivateEvent and Change, that are provided only at the application level in the Excel object model. That is, in the Excel object model, these events are defined in the Microsoft.Office.Interop.Excel.Application class rather than the Microsoft.Office.Interop.Excel.Worksheet class.

Creating Worksheet Host Items

You cannot create WorksheetBase objects programmatically in Office projects.

In document-level projects, the Sheetn classes (which derive from WorksheetBase) are instantiated automatically by the Visual Studio Tools for Office runtime when the end user opens the workbook. For more information, see Programming Document-Level Customizations.

In application-level projects, you can create worksheet host items programmatically by using the GetVstoObject method. The worksheet host item you create is a Microsoft.Office.Tools.Excel.Worksheet object, rather than a WorksheetBase object. For more information, see Extending Word Documents and Excel Workbooks in VSTO Add-ins at Run Time.

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

WorksheetBase(Factory, IServiceProvider, String, String)

Properties

Application	Gets a Application object that represents the Microsoft Office Excel application.
AutoFilter	Gets a AutoFilter that provides information about filtered lists on the worksheet if filtering is enabled. Gets `null` if filtering is off.
AutoFilterMode	Gets or sets a value that indicates whether filtering is currently enabled on the worksheet (that is, whether the filter drop-down arrows are currently displayed).
Base	Gets the Worksheet object that this WorksheetBase object extends.
BindingContext
Cells	Gets a Range object that represents all the cells on the worksheet (not just the cells that are currently in use).
CircularReference	Gets a Range object that represents the range containing the first circular reference on the sheet, or gets `null` if there is no circular reference on the sheet.
Columns	Gets a Range object that represents one or more columns on the worksheet.
Comments	Gets a Comments collection that represents all the comments for the worksheet.
ConsolidationFunction	Gets the function code used for the current consolidation.
ConsolidationOptions	Gets a three-element Array of consolidation options.
ConsolidationSources	Gets an Array of strings that name the source sheets and ranges for the worksheet's current consolidation.
Controls	Gets the collection of managed controls that are contained on the worksheet.
Creator	Gets a value that indicates the application in which the worksheet was created.
CustomProperties	Gets a CustomProperties object representing the identifier information associated with a worksheet.
DataBindings
DataHost
DisplayPageBreaks	Gets or sets a value that indicates whether page breaks (both automatic and manual) on the worksheet are displayed.
DisplayRightToLeft	Gets or sets a value that indicates whether the worksheet is displayed from right to left instead of from left to right.
EnableAutoFilter	Gets or sets a value that indicates whether AutoFilter arrows are enabled when user-interface-only protection is turned on.
EnableCalculation	Gets or set a value that indicates whether Microsoft Office Excel automatically recalculates the worksheet when necessary.
EnableFormatConditionsCalculation	Gets or sets a value that determines whether conditional formats will occur automatically.
EnableOutlining	Gets or sets a value that indicates whether outlining symbols are enabled when user-interface-only protection is turned on. This type or member is intended to be used only in projects for the 2007 Microsoft Office system. Smart tags are deprecated in Office 2010.. This type or member is intended to be used only in projects for the 2007 Microsoft Office system. Smart tags are deprecated in Office 2010..
EnablePivotTable	Gets or sets a value that indicates whether PivotTable controls and actions are enabled when user-interface-only protection is turned on.
EnableSelection	Gets or sets a value indicating which cells can be selected on the sheet.
FilterMode	Gets a value that indicates whether the worksheet is actively filtering data.
HostContext
HPageBreaks	Gets an HPageBreaks collection that represents the horizontal page breaks on the sheet.
Hyperlinks	Gets a Hyperlinks collection that represents the hyperlinks for the range or worksheet.
Index	Gets the index number of the worksheet within the collection of worksheets.
InnerObject	Gets a Worksheet that represents the underlying native object for the WorksheetBase.
ItemProvider
ListObjects	Gets a collection of ListObject objects in the worksheet.
MailEnvelope	Gets an e-mail header for the worksheet.
Name	Gets or sets the name of the worksheet.
Names	Gets a Names collection that represents all the worksheet-specific names (names defined with the "WorksheetName!" prefix).
Next	Gets a Worksheet that represents the next sheet.
Outline	Gets an Outline that represents the outline for the worksheet.
PageSetup	Gets a PageSetup that contains all the page setup settings for the worksheet.
Parent	Gets the parent object for the worksheet.
Previous	Gets a Worksheet that represents the previous sheet.
PrintedCommentPages	Gets the number of comment pages that will be printed for the current worksheet. This property can be used only in Excel 2010 projects.
ProtectContents	Gets a value that indicates whether the contents of the worksheet (the individual cells) are protected.
ProtectDrawingObjects	Gets a value that indicates whether shapes are protected.
Protection	Gets a Protection object that represents the protection options of the worksheet.
ProtectionMode	Gets a value that indicates whether user interface-only protection is turned on.
ProtectScenarios	Gets a value that indicates whether worksheet scenarios are protected.
QueryTables	Gets the QueryTables collection that represents all the query tables on the worksheet.
Range	Gets a Range object that represents a cell or a range of cells.
Rows	Gets a Range object that represents one or more rows on the worksheet.
ScrollArea	Gets or sets the range where scrolling is allowed, as an A1-style range reference.
Shapes	Gets a Shapes object that represents all the shapes on the worksheet.
Site
Sort	Gets the sorted values in the current worksheet.
StandardHeight	Gets the standard (default) height of all the rows in the worksheet, in points.
StandardWidth	Gets or sets the standard (default) width of all the columns in the worksheet.
Tab	Gets a Tab for the worksheet.
Tag	Gets or sets the object that contains data about the worksheet.
TransitionExpEval	Gets or sets a value that indicates whether Microsoft Office Excel uses Lotus 1-2-3 expression evaluation rules for the worksheet.
TransitionFormEntry	Gets or sets a value that indicates whether Microsoft Office Excel uses Lotus 1-2-3 formula entry rules for the worksheet.
Type	Gets the worksheet type.
UsedRange	Gets a Range object that represents all the cells that have contained a value at any time.
Visible	Gets or sets a XlSheetVisibility value that determines whether the object is visible.
VPageBreaks	Gets a VPageBreaks collection that represents the vertical page breaks on the sheet.

Methods

Activate()
BeginInit()
CalculateMethod()	Calculates the formulas in the worksheet.
ChartObjects(Object)	Gets an object that represents either a single embedded chart (a ChartObject) or a collection of all the embedded charts (a ChartObjects) on the worksheet.
CheckSpelling(Object, Object, Object, Object)
CircleInvalid()	Circles invalid entries on the worksheet.
ClearArrows()	Clears the tracer arrows from the worksheet. Tracer arrows are added by using the auditing feature.
ClearCircles()	Clears circles from invalid entries on the worksheet.
Copy(Object, Object)	Copies the worksheet to another location in the workbook.
Delete()	Deletes the underlying Worksheet object, but does not delete the host item. It is highly recommended that this method not be used.
Dispose()	Releases all resources used by the current instance of the WorksheetBase class.
EndInit()
Evaluate(Object)	Converts a Microsoft Office Excel name to an object or a value.
ExportAsFixedFormat(XlFixedFormatType, Object, Object, Object, Object, Object, Object, Object, Object)	Exports to a file of the specified format.
FinishInitialization()
GetAutomationObject()	Called by the Visual Studio Tools for Office runtime to get an object that can be used by VBA code in the worksheet.
Initialize()
InitializeDataBindings()
Move(Object, Object)	Moves the worksheet 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 worksheet.
OnShutdown()
OnStartup()
Paste(Object, Object)	Pastes the contents of the Clipboard onto the worksheet.
PasteSpecial(Object, Object, Object, Object, Object, Object, Object)	Pastes the contents of the Clipboard onto the worksheet, using a specified format. Use this method to paste data from other applications or to paste data in a specific format.
PivotTables(Object)	Gets an object that represents either a single PivotTable report (a PivotTable object) or a collection of all the PivotTable reports (a PivotTables object) on a worksheet.
PivotTableWizard(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object)	Creates a PivotTable object.
PrintOutEx(Object, Object, Object, Object, Object, Object, Object, Object, Object)	Prints the worksheet.
PrintPreview(Object)	Shows a preview of the worksheet as it would look when printed.
Protect(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object)	Protects a worksheet so that it cannot be modified.
ResetAllPageBreaks()	Resets all page breaks on the specified worksheet.
SaveAs(String, Object, Object, Object, Object, Object, Object, Object, Object, Object)	Saves changes to the worksheet in a different file.
Scenarios(Object)	Gets an object that represents either a single scenario (a Scenario object) or a collection of scenarios (a Scenarios object) on the worksheet.
Select(Object)	Selects the worksheet.
SetBackgroundPicture(String)	Sets the background graphic for the worksheet.
ShowAllData()	Makes all rows of the currently filtered list visible. If AutoFilter is in use, this method changes the arrows to "All."
ShowDataForm()	Displays the data form associated with the worksheet.
Unprotect(Object)	Removes protection from the worksheet. This method has no effect if the worksheet is not protected.
XmlDataQuery(String, Object, Object)	Gets a Range object that represents the cells mapped to a particular XPath. Gets `null` if the specified XPath has not been mapped to the worksheet, or if the mapped range is empty.
XmlMapQuery(String, Object, Object)	Gets a Range object that represents the cells mapped to a particular XPath. Gets `null` if the specified XPath has not been mapped to the worksheet.

Events

ActivateEvent	Occurs when the worksheet is activated.
BeforeDoubleClick	Occurs when the worksheet is double-clicked, before the default double-click action.
BeforeRightClick	Occurs when the worksheet is right-clicked, before the default right-click action.
BindingContextChanged
Calculate	Occurs after the worksheet is recalculated.
Change	Occurs when something changes in the WorksheetBase cells.
Deactivate	Occurs when the worksheet loses focus.
Disposed
FollowHyperlink	Occurs when you click any hyperlink on a worksheet.
PivotTableAfterValueChange	Occurs after a cell or range of cells inside a PivotTable are edited or recalculated (for cells that contain formulas). This event can be used only in Excel 2010 projects.
PivotTableBeforeAllocateChanges	Occurs before changes are applied to a PivotTable. This event can be used only in Excel 2010 projects.
PivotTableBeforeCommitChanges	Occurs before changes are committed against the OLAP data source for a PivotTable. This event can be used only in Excel 2010 projects.
PivotTableBeforeDiscardChanges	Occurs before changes to a PivotTable are discarded. This event can be used only in Excel 2010 projects.
PivotTableChangeSync	Occurs after changes to a PivotTable. This event can be used only in Excel 2010 projects.
PivotTableUpdate	Occurs after a PivotTable report is updated on a worksheet.
SelectionChange	Occurs when the selection changes on a worksheet.
Shutdown	Occurs when the worksheet host item shuts down.
Startup

Explicit Interface Implementations

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

Applies to

Share via