Worksheet Interface

Represents a worksheet in Excel projects created by using the Office development tools in Visual Studio.

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

Syntax

'Declaration
<GuidAttribute("297dc8d9-eabd-45a1-bdef-68ab67e5c3c3")> _
Public Interface Worksheet _
    Inherits IBindableComponent, IComponent, IDisposable, ISupportInitialize
[GuidAttribute("297dc8d9-eabd-45a1-bdef-68ab67e5c3c3")]
public interface Worksheet : IBindableComponent, 
    IComponent, IDisposable, ISupportInitialize

The Worksheet type exposes the following members.

Properties

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

Top

Methods

  Name Description
Public method _CheckSpelling Infrastructure.
Public method _Evaluate Infrastructure.
Public method _PasteSpecial Infrastructure.
Public method _PrintOut Infrastructure.
Public method _Protect Infrastructure.
Public method _SaveAs Infrastructure.
Public method _VtblGap1_1
Public method _VtblGap2_1
Public method _VtblGap3_1
Public method _VtblGap4_1
Public method _VtblGap5_1
Public method _VtblGap6_1
Public method _VtblGap7_1
Public method Activate Makes the current sheet the active sheet.
Public method Arcs Infrastructure.
Public method BeginInit Signals the object that initialization is starting. (Inherited from ISupportInitialize.)
Public method Buttons Infrastructure.
Public method CalculateMethod Calculates the formulas in the worksheet.
Public method ChartObjects 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.
Public method CheckBoxes Infrastructure.
Public method CheckSpelling Checks the spelling in a worksheet.
Public method CircleInvalid Circles invalid entries on the worksheet.
Public method ClearArrows Clears the tracer arrows from the worksheet. Tracer arrows are added by using the auditing feature.
Public method ClearCircles Clears circles from invalid entries on the worksheet.
Public method Copy Copies the worksheet to another location in the workbook.
Public method Delete Deletes the underlying Worksheet object, but does not delete the host item. It is highly recommended that this method not be used.
Public method Dispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
Public method DrawingObjects Infrastructure.
Public method Drawings Infrastructure.
Public method DropDowns Infrastructure.
Public method EndInit Signals the object that initialization is complete. (Inherited from ISupportInitialize.)
Public method Evaluate Converts a Microsoft Office Excel name to an object or a value.
Public method ExportAsFixedFormat Exports to a file of the specified format.
Public method get_Range Gets a Range object that represents a cell or a range of cells. Use the Range property instead of this method.
Public method GroupBoxes Infrastructure.
Public method GroupObjects Infrastructure.
Public method Labels Infrastructure.
Public method Lines Infrastructure.
Public method ListBoxes Infrastructure.
Public method Move Moves the worksheet 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 worksheet.
Public method OptionButtons Infrastructure.
Public method Ovals Infrastructure.
Public method Paste Pastes the contents of the Clipboard onto the worksheet.
Public method PasteSpecial 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.
Public method Pictures Infrastructure.
Public method PivotTables 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.
Public method PivotTableWizard Creates a PivotTable object.
Public method PrintOut Prints the worksheet.
Public method PrintOutEx Prints the worksheet.
Public method PrintPreview Shows a preview of the worksheet as it would look when printed.
Public method Protect Protects a worksheet so that it cannot be modified.
Public method Rectangles Infrastructure.
Public method ResetAllPageBreaks Resets all page breaks on the specified worksheet.
Public method SaveAs Saves changes to the worksheet in a different file.
Public method Scenarios Gets an object that represents either a single scenario (a Scenario object) or a collection of scenarios (a Scenarios object) on the worksheet.
Public method ScrollBars Infrastructure.
Public method Select Selects the worksheet.
Public method SetBackgroundPicture Sets the background graphic for the worksheet.
Public method ShowAllData Makes all rows of the currently filtered list visible. If AutoFilter is in use, this method changes the arrows to "All."
Public method ShowDataForm Displays the data form associated with the worksheet.
Public method Spinners Infrastructure.
Public method TextBoxes Infrastructure.
Public method Unprotect Removes protection from the worksheet. This method has no effect if the worksheet is not protected.
Public method XmlDataQuery Gets a Range object that represents the cells mapped to a particular XPath. Gets nulla null reference (Nothing in Visual Basic) if the specified XPath has not been mapped to the worksheet, or if the mapped range is empty.
Public method XmlMapQuery Gets a Range object that represents the cells mapped to a particular XPath. Gets nulla null reference (Nothing in Visual Basic) if the specified XPath has not been mapped to the worksheet.

Top

Events

  Name Description
Public event ActivateEvent Occurs when the worksheet is activated.
Public event BeforeDoubleClick Occurs when the worksheet is double-clicked, before the default double-click action.
Public event BeforeRightClick Occurs when the worksheet is right-clicked, before the default right-click action.
Public event BindingContextChanged Infrastructure.
Public event Calculate Occurs after the worksheet is recalculated.
Public event Change Occurs when something changes in the Worksheet cells.
Public event Deactivate Occurs when the worksheet loses focus.
Public event Disposed Represents the method that handles the Disposed event of a component. (Inherited from IComponent.)
Public event FollowHyperlink Occurs when you click any hyperlink on a worksheet.
Public event PivotTableAfterValueChange Occurs after a cell or range of cells inside a PivotTable are edited or recalculated (for cells that contain formulas).
Public event PivotTableBeforeAllocateChanges Occurs before changes are applied to a PivotTable.
Public event PivotTableBeforeCommitChanges Occurs before changes are committed against the OLAP data source for a PivotTable.
Public event PivotTableBeforeDiscardChanges Occurs before changes to a PivotTable are discarded.
Public event PivotTableChangeSync Occurs after changes to a PivotTable.
Public event PivotTableUpdate Occurs after a PivotTable report is updated on a worksheet.
Public event SelectionChange Occurs when the selection changes on a worksheet.
Public event Shutdown Occurs when the worksheet host item shuts down.
Public event Startup Occurs after the worksheet is running and all the initialization code in the assembly has been run.

Top

Remarks

A Microsoft.Office.Tools.Excel.Worksheet object provides the same members as a Worksheet object from 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 Worksheet object for a Microsoft.Office.Tools.Excel.Worksheet host item.

  • Worksheet-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 Application class rather than the Worksheet interface.

In application-level projects, you can create Microsoft.Office.Tools.Excel.Worksheet objects programmatically by using the GetVstoObject method. For more information, see Extending Word Documents and Excel Workbooks in Application-Level Add-ins at Run Time.

In document-level projects, you typically do not use Microsoft.Office.Tools.Excel.Worksheet object directly. Instead, use the Sheetn classes to programmatically access the worksheets in your project. Each Sheetn class derives most of its members from the Microsoft.Office.Tools.Excel.WorksheetBase class. This class redirects all calls to its members to an internal implementation of the Microsoft.Office.Tools.Excel.Worksheet interface in the Visual Studio Tools for Office runtime. For more information, see Programming Document-Level Customizations.

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 and the .NET Framework 4.5. 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.

See Also

Reference

Microsoft.Office.Tools.Excel Namespace

Other Resources

Host Items and Host Controls Overview

Worksheet Host Item