Represents a worksheet in Excel projects created by using the Office development tools in Visual Studio.
[System.Runtime.InteropServices.Guid("297dc8d9-eabd-45a1-bdef-68ab67e5c3c3")] [System.Runtime.InteropServices.TypeIdentifier] public interface Worksheet : IDisposable, System.ComponentModel.IComponent, System.ComponentModel.ISupportInitialize, System.Windows.Forms.IBindableComponent
A Microsoft.Office.Tools.Excel.Worksheet object provides the same members as a Microsoft.Office.Interop.Excel.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.
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 Microsoft.Office.Interop.Excel.Application class rather than the Microsoft.Office.Interop.Excel.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 VSTO 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.
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.
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.
This property gets a Application that represents the Microsoft Office Excel application.
Gets a AutoFilter that provides information about filtered lists on the worksheet if filtering is enabled. Gets
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).
Gets a Range object that represents all the cells on the worksheet (not just the cells that are currently in use).
Gets a Range object that represents the range containing the first circular reference on the sheet, or gets
Gets a Range object that represents one or more columns on the worksheet.
Gets a Comments collection that represents all the comments for the worksheet.
Gets the function code used for the current consolidation.
Gets a three-element Array of consolidation options.
Gets an Array of strings that name the source sheets and ranges for the worksheet's current consolidation.
Gets the collection of managed controls that are contained on the worksheet.
Gets a value that indicates the application in which the worksheet was created.
Gets a CustomProperties object representing the identifier information associated with a worksheet.
Gets the default extension for this Worksheet object.
Gets or sets a value that indicates whether page breaks (both automatic and manual) on the worksheet are displayed.
Gets or sets a value that indicates whether the worksheet is displayed from right to left instead of from left to right.
Gets or sets a value that indicates whether AutoFilter arrows are enabled when user-interface-only protection is turned on.
Gets or set a value that indicates whether Microsoft Office Excel automatically recalculates the worksheet when necessary.
Gets or sets a value that determines whether conditional formats will occur automatically.
Gets or sets a value that indicates whether outlining symbols are enabled when user-interface-only protection is turned on.
Gets or sets a value that indicates whether PivotTable controls and actions are enabled when user-interface-only protection is turned on.
Gets or sets a value indicating which cells can be selected on the sheet.
Gets a custom extension for this Worksheet object.
Gets a value that indicates whether the worksheet is actively filtering data.
Gets an HPageBreaks collection that represents the horizontal page breaks on the sheet.
Gets a Hyperlinks collection that represents the hyperlinks for the range or worksheet.
Gets the index number of the worksheet within the collection of worksheets.
Gets a collection of ListObject objects in the worksheet.
Gets an e-mail header for the worksheet.
Gets or sets the name of the worksheet.
Gets a Names collection that represents all the worksheet-specific names (names defined with the "WorksheetName!" prefix).
Gets a Worksheet that represents the next sheet.
Gets an Outline that represents the outline for the worksheet.
Gets a PageSetup that contains all the page setup settings for the worksheet.
Gets the parent object for the worksheet.
Gets a Worksheet that represents the previous sheet.
Gets the number of comment pages that will be printed for the current worksheet.
Gets a value that indicates whether the contents of the worksheet (the individual cells) are protected.
Gets a value that indicates whether shapes are protected.
Gets a Protection object that represents the protection options of the worksheet.
Gets a value that indicates whether user interface-only protection is turned on.
Gets a value that indicates whether worksheet scenarios are protected.
Gets the QueryTables collection that represents all the query tables on the worksheet.
Gets a Range object that represents a cell or a range of cells.
Gets a Range object that represents one or more rows on the worksheet.
Gets or sets the range where scrolling is allowed, as an A1-style range reference.
Gets a Shapes object that represents all the shapes on the worksheet.
Gets the sorted values in the current worksheet.
Gets the standard (default) height of all the rows in the worksheet, in points.
Gets or sets the standard (default) width of all the columns in the worksheet.
Gets a Tab for the worksheet.
Gets or sets the object that contains data about the worksheet.
Gets or sets a value that indicates whether Microsoft Office Excel uses Lotus 1-2-3 expression evaluation rules for the worksheet.
Gets or sets a value that indicates whether Microsoft Office Excel uses Lotus 1-2-3 formula entry rules for the worksheet.
Gets the worksheet type.
Gets a Range object that represents all the cells that have contained a value at any time.
Gets or sets a XlSheetVisibility value that determines whether the object is visible.
Gets a VPageBreaks collection that represents the vertical page breaks on the sheet.
Makes the current sheet the active sheet.
Calculates the formulas in the worksheet.
|CheckSpelling(Object, Object, Object, Object)||
Checks the spelling in a worksheet.
Circles invalid entries on the worksheet.
Clears the tracer arrows from the worksheet. Tracer arrows are added by using the auditing feature.
Clears circles from invalid entries on the worksheet.
Copies the worksheet to another location in the workbook.
Deletes the underlying Worksheet object, but does not delete the host item. It is highly recommended that this method not be used.
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.
Moves the worksheet to another location in the workbook.
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.
|PivotTableWizard(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object)||
Creates a PivotTable object.
|PrintOut(Object, Object, Object, Object, Object, Object, Object, Object)|
|PrintOutEx(Object, Object, Object, Object, Object, Object, Object, Object, Object)||
Prints the worksheet.
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.
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.
Selects the worksheet.
Sets the background graphic for the worksheet.
Makes all rows of the currently filtered list visible. If AutoFilter is in use, this method changes the arrows to "All."
Displays the data form associated with the worksheet.
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
|XmlMapQuery(String, Object, Object)||
Gets a Range object that represents the cells mapped to a particular XPath. Gets
Occurs when the worksheet is activated.
Occurs when the worksheet is double-clicked, before the default double-click action.
Occurs when the worksheet is right-clicked, before the default right-click action.
Occurs after the worksheet is recalculated.
Occurs when something changes in the Worksheet cells.
Occurs when the worksheet loses focus.
Occurs when you click any hyperlink on a worksheet.
Occurs after a cell or range of cells inside a PivotTable are edited or recalculated (for cells that contain formulas).
Occurs before changes are applied to a PivotTable.
Occurs before changes are committed against the OLAP data source for a PivotTable.
Occurs before changes to a PivotTable are discarded.
Occurs after changes to a PivotTable.
Occurs after a PivotTable report is updated on a worksheet.
Occurs when the selection changes on a worksheet.
Occurs when the worksheet host item shuts down.
Occurs after the worksheet is running and all the initialization code in the assembly has been run.