Worksheet 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.
public interface class Worksheet : Microsoft::Office::Interop::Excel::_Worksheet, Microsoft::Office::Interop::Excel::DocEvents_Event[System.Runtime.InteropServices.Guid("000208D8-0000-0000-C000-000000000046")]
public interface Worksheet : Microsoft.Office.Interop.Excel._Worksheet, Microsoft.Office.Interop.Excel.DocEvents_EventPublic Interface Worksheet
Implements _Worksheet, DocEvents_Event- Derived
- Attributes
- Implements
Remarks
This is a .NET interface derived from a COM coclass that is required by managed code for interoperability with the corresponding COM object. Use this derived interface to access all method, property, and event members of the COM object. However, if a method or event you want to use shares the same name under the same COM object, cast to the corresponding primary interface to call the method, and cast to the latest events interface to connect to the event. Refer to this topic for information about the COM object. For information about the method and property members of the COM object, see _Worksheet.
The Worksheet object is a member of the Worksheets collection. The Worksheets collection contains all the Worksheet objects in a workbook.
The following properties for returning a Worksheet object are described in this section:
- Worksheets property
- ActiveSheet property
Worksheets Property
Use Worksheets(index), where index is the worksheet index number or name, to return a single Worksheet object.
The worksheet index number denotes the position of the worksheet on the workbook’s tab bar. Worksheets(1) is the first (leftmost) worksheet in the workbook, and Worksheets(Worksheets.Count) is the last one. All worksheets are included in the index count, even if they’re hidden.
The worksheet name is shown on the tab for the worksheet. Use the Name property to set or return the worksheet name.
The Worksheet object is also a member of the Sheets collection. The Sheets collection contains all the sheets in the workbook (both chart sheets and worksheets).
ActiveSheet Property
When a worksheet is the active sheet, you can use the ActiveSheet property to refer to it.
Properties
| _CodeName |
Reserved for internal use. (Inherited from _Worksheet) |
| _DisplayRightToLeft |
Reserved for internal use. (Inherited from _Worksheet) |
| Application |
When used without an object qualifier, this property returns an Application object that represents the Microsoft Excel application. When used with an object qualifier, this property returns an Application object that represents the creator of the specified object (you can use this property with an OLE Automation object to return the application of that object). Read-only. (Inherited from _Worksheet) |
| AutoFilter |
Returns an AutoFilter object if filtering is on. Returns Nothing if filtering is off. Read-only. (Inherited from _Worksheet) |
| AutoFilterMode |
True if the AutoFilter drop-down arrows are currently displayed on the sheet. This property is independent of the FilterMode property. Read/write Boolean. (Inherited from _Worksheet) |
| Cells |
Returns a Range object that represents all the cells on the worksheet (not just the cells that are currently in use). Read-only. (Inherited from _Worksheet) |
| CircularReference |
Returns a Range object that represents the range containing the first circular reference on the sheet, or returns Nothing if there's no circular reference on the sheet. The circular reference must be removed before calculation can proceed. Read-only. (Inherited from _Worksheet) |
| CodeName |
Returns the code name for the object. Read-only String. (Inherited from _Worksheet) |
| Columns |
Returns a Range object that represents all the columns on the specified worksheet. Read-only. (Inherited from _Worksheet) |
| Comments |
Returns a Comments collection that represents all the comments for the specified worksheet. Read-only. (Inherited from _Worksheet) |
| ConsolidationFunction |
Returns the function code used for the current consolidation. Can be one of the XlConsolidationFunction constants. Read-only. (Inherited from _Worksheet) |
| ConsolidationOptions |
Returns a three-element array of consolidation options, as shown in the following table. If the element is True, that option is set. Read-only Object. (Inherited from _Worksheet) |
| ConsolidationSources |
Returns an array of string values that name the source sheets for the worksheet's current consolidation. Returns Empty if there's no consolidation on the sheet. Read-only Object. (Inherited from _Worksheet) |
| Creator |
Returns a constant in the XlCreator enumeration that indicates the application in which this object was created. If the object was created in Microsoft Excel, this property returns the string XCEL, which is equivalent to the hexadecimal number 5843454C. Read-only xlCreatorCode. (Inherited from _Worksheet) |
| CustomProperties |
Returns a CustomProperties object representing the identifier information associated with a worksheet. (Inherited from _Worksheet) |
| DisplayAutomaticPageBreaks |
Reserved for internal use. (Inherited from _Worksheet) |
| DisplayPageBreaks |
True if page breaks (both automatic and manual) on the specified worksheet are displayed. Read/write Boolean. (Inherited from _Worksheet) |
| DisplayRightToLeft |
True if the specified window, worksheet, or ListObject is displayed from right to left instead of from left to right. False if the object is displayed from left to right. Read-only Boolean. (Inherited from _Worksheet) |
| EnableAutoFilter |
True if AutoFilter arrows are enabled when user-interface-only protection is turned on. Read/write Boolean. (Inherited from _Worksheet) |
| EnableCalculation |
True if Microsoft Excel automatically recalculates the worksheet when necessary. False if Excel doesn't recalculate the sheet. Read/write Boolean. (Inherited from _Worksheet) |
| EnableFormatConditionsCalculation |
Returns or sets if conditional formats will occur automatically as needed. Read/write Boolean. (Inherited from _Worksheet) |
| EnableOutlining |
True if outlining symbols are enabled when user-interface-only protection is turned on. Read/write Boolean. (Inherited from _Worksheet) |
| EnablePivotTable |
True if PivotTable controls and actions are enabled when user-interface-only protection is turned on. Read/write Boolean. (Inherited from _Worksheet) |
| EnableSelection |
Returns or sets what can be selected on the sheet. Read/write XlEnableSelection. (Inherited from _Worksheet) |
| FilterMode |
True if the worksheet is in filter mode. Read-only Boolean. (Inherited from _Worksheet) |
| HPageBreaks |
Returns an HPageBreaks collection that represents the horizontal page breaks on the sheet. Read-only. (Inherited from _Worksheet) |
| Hyperlinks |
Returns a Hyperlinks collection that represents the hyperlinks for the range or worksheet. (Inherited from _Worksheet) |
| Index |
Returns the index number of the object within the collection of similar objects. Read-only Integer. (Inherited from _Worksheet) |
| ListObjects |
Returns a collection of ListObject objects in the worksheet. Read-only ListObjects collection. (Inherited from _Worksheet) |
| MailEnvelope |
Represents an e-mail header for a document. (Inherited from _Worksheet) |
| Name |
Returns or sets the name of the object. Read/write String. (Inherited from _Worksheet) |
| Names |
Returns a Names collection that represents all the worksheet-specific names (names defined with the "WorksheetName!" prefix). Read-only Names object. (Inherited from _Worksheet) |
| Next |
Returns a Chart, Range, or Worksheet object that represents the next sheet or cell. Read-only. (Inherited from _Worksheet) |
| OnCalculate |
Reserved for internal use. (Inherited from _Worksheet) |
| OnData |
Reserved for internal use. (Inherited from _Worksheet) |
| OnDoubleClick |
Reserved for internal use. (Inherited from _Worksheet) |
| OnEntry |
Reserved for internal use. (Inherited from _Worksheet) |
| OnSheetActivate |
Reserved for internal use. (Inherited from _Worksheet) |
| OnSheetDeactivate |
Reserved for internal use. (Inherited from _Worksheet) |
| Outline |
Returns an Outline object that represents the outline for the specified worksheet. Read-only. (Inherited from _Worksheet) |
| PageSetup |
Returns a PageSetup object that contains all the page setup settings for the specified object. Read-only. (Inherited from _Worksheet) |
| Parent |
Returns the parent object for the specified object. Read-only. (Inherited from _Worksheet) |
| Previous |
Returns a Chart, Range, or Worksheet object that represents the previous sheet or cell. Read-only. (Inherited from _Worksheet) |
| PrintedCommentPages |
Gets the number of comment pages that will be printed for the current worksheet. (Inherited from _Worksheet) |
| ProtectContents |
True if the contents of the sheet are protected. For a chart, this protects the entire chart. For a worksheet, this protects the individual cells. Read-only Boolean. (Inherited from _Worksheet) |
| ProtectDrawingObjects |
True if shapes are protected. Read-only Boolean. (Inherited from _Worksheet) |
| Protection |
Returns a Protection object that represents the protection options of the worksheet. (Inherited from _Worksheet) |
| ProtectionMode |
True if user-interface-only protection is turned on. To turn on user interface protection, use the Protect(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object) method with the |
| ProtectScenarios |
True if the worksheet scenarios are protected. Read-only Boolean. (Inherited from _Worksheet) |
| QueryTables |
Returns the QueryTables collection that represents all the query tables on the specified worksheet. Read-only. (Inherited from _Worksheet) |
| Range[Object, Object] |
Returns a Range object that represents a cell or a range of cells. (Inherited from _Worksheet) |
| Rows |
Returns a Range object that represents all the rows on the specified worksheet. Read-only Range object. (Inherited from _Worksheet) |
| Scripts |
Returns the Scripts collection, which contains Script objects representing blocks of script or code in the specified document when it’s saved as a Web page. (Inherited from _Worksheet) |
| ScrollArea |
Returns or sets the range where scrolling is allowed as an A1-style range reference. Cells outside the scroll area cannot be selected. Read/write String. (Inherited from _Worksheet) |
| Shapes |
Returns a Shapes object that represents all the shapes on the worksheet or chart sheet. Read-only. (Inherited from _Worksheet) |
| SmartTags |
Returns a SmartTags object representing the identifier for the specified cell. (Inherited from _Worksheet) |
| Sort |
Returns the sorted values in the current worksheet. Read-only. (Inherited from _Worksheet) |
| StandardHeight |
Returns the standard (default) height of all the rows in the worksheet in points. Read-only Double. (Inherited from _Worksheet) |
| StandardWidth |
Returns or sets the standard (default) width of all the columns in the worksheet. Read/write Double. (Inherited from _Worksheet) |
| Tab |
Returns a Tab object for a chart or a worksheet. (Inherited from _Worksheet) |
| TransitionExpEval |
True if Microsoft Excel uses Lotus 1-2-3 expression evaluation rules for the worksheet. Read/write Boolean. (Inherited from _Worksheet) |
| TransitionFormEntry |
True if Microsoft Excel uses Lotus 1-2-3 formula entry rules for the worksheet. Read/write Boolean. (Inherited from _Worksheet) |
| Type |
Returns or sets the worksheet type. Read-only XlSheetType. (Inherited from _Worksheet) |
| UsedRange |
Returns a Range object that represents the used range on the specified worksheet. Read-only. (Inherited from _Worksheet) |
| Visible |
Determines whether the object is visible. Read/write XlSheetVisibility. (Inherited from _Worksheet) |
| VPageBreaks |
Returns a VPageBreaks collection that represents the vertical page breaks on the sheet. Read-only. (Inherited from _Worksheet) |
Methods
| _CheckSpelling(Object, Object, Object, Object, Object, Object) |
Reserved for internal use. (Inherited from _Worksheet) |
| _Evaluate(Object) |
Reserved for internal use. (Inherited from _Worksheet) |
| _PasteSpecial(Object, Object, Object, Object, Object, Object) |
Reserved for internal use. (Inherited from _Worksheet) |
| _PrintOut(Object, Object, Object, Object, Object, Object, Object) |
Reserved for internal use. (Inherited from _Worksheet) |
| _Protect(Object, Object, Object, Object, Object) |
Reserved for internal use. (Inherited from _Worksheet) |
| _SaveAs(String, Object, Object, Object, Object, Object, Object, Object, Object) |
Reserved for internal use. (Inherited from _Worksheet) |
| Arcs(Object) |
Reserved for internal use. (Inherited from _Worksheet) |
| Buttons(Object) |
Reserved for internal use. (Inherited from _Worksheet) |
| ChartObjects(Object) |
Returns 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. (Inherited from _Worksheet) |
| CheckBoxes(Object) |
Reserved for internal use. (Inherited from _Worksheet) |
| CheckSpelling(Object, Object, Object, Object) |
Checks the spelling of an object. This form has no return value; Microsoft Excel displays the Spelling dialog box. (Inherited from _Worksheet) |
| CircleInvalid() |
Circles invalid entries on the worksheet. (Inherited from _Worksheet) |
| ClearArrows() |
Clears the tracer arrows from the worksheet. Tracer arrows are added by using the auditing feature. (Inherited from _Worksheet) |
| ClearCircles() |
Clears circles from invalid entries on the worksheet. (Inherited from _Worksheet) |
| Copy(Object, Object) |
Copies the sheet to another location in the workbook. (Inherited from _Worksheet) |
| Delete() |
Deletes the object. (Inherited from _Worksheet) |
| DrawingObjects(Object) |
Reserved for internal use. (Inherited from _Worksheet) |
| Drawings(Object) |
Reserved for internal use. (Inherited from _Worksheet) |
| DropDowns(Object) |
Reserved for internal use. (Inherited from _Worksheet) |
| Evaluate(Object) |
Converts a Microsoft Excel name to an object or a value. (Inherited from _Worksheet) |
| ExportAsFixedFormat(XlFixedFormatType, Object, Object, Object, Object, Object, Object, Object, Object) |
Exports to a file of the specified format. (Inherited from _Worksheet) |
| GroupBoxes(Object) |
Reserved for internal use. (Inherited from _Worksheet) |
| GroupObjects(Object) |
Reserved for internal use. (Inherited from _Worksheet) |
| Labels(Object) |
Reserved for internal use. (Inherited from _Worksheet) |
| Lines(Object) |
Reserved for internal use. (Inherited from _Worksheet) |
| ListBoxes(Object) |
Reserved for internal use. (Inherited from _Worksheet) |
| Move(Object, Object) |
Moves the sheet to another location in the workbook (Inherited from _Worksheet) |
| OLEObjects(Object) |
Returns 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. Read-only. (Inherited from _Worksheet) |
| OptionButtons(Object) |
Reserved for internal use. (Inherited from _Worksheet) |
| Ovals(Object) |
Reserved for internal use. (Inherited from _Worksheet) |
| Paste(Object, Object) |
Pastes the contents of the Clipboard onto the sheet. (Inherited from _Worksheet) |
| PasteSpecial(Object, Object, Object, Object, Object, Object, Object) |
Pastes the contents of the Clipboard onto the sheet using a specified format. Use this method to paste data from other applications or to paste data in a specific format. (Inherited from _Worksheet) |
| Pictures(Object) |
Reserved for internal use. (Inherited from _Worksheet) |
| PivotTables(Object) |
Returns 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. Read-only. (Inherited from _Worksheet) |
| PivotTableWizard(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object) |
Creates a PivotTable object. This method doesn’t display the PivotTable Wizard. This method isn’t available for OLE DB data sources. Use the Add(Object, Object, Object, Object) method to add a PivotTable cache, and then create a PivotTable report based on the cache. PivotTable object. (Inherited from _Worksheet) |
| PrintOut(Object, Object, Object, Object, Object, Object, Object, Object) |
Prints the object. (Inherited from _Worksheet) |
| PrintOutEx(Object, Object, Object, Object, Object, Object, Object, Object, Object) |
Reserved for internal use. (Inherited from _Worksheet) |
| PrintPreview(Object) |
Shows a preview of the object as it would look when printed. (Inherited from _Worksheet) |
| 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. (Inherited from _Worksheet) |
| Rectangles(Object) |
Reserved for internal use. (Inherited from _Worksheet) |
| ResetAllPageBreaks() |
Resets all page breaks on the specified worksheet. (Inherited from _Worksheet) |
| SaveAs(String, Object, Object, Object, Object, Object, Object, Object, Object, Object) |
Saves changes to the chart or worksheet in a different file. (Inherited from _Worksheet) |
| Scenarios(Object) |
Returns an object that represents either a single scenario (a Scenario object) or a collection of scenarios (a Scenarios object) on the worksheet. (Inherited from _Worksheet) |
| ScrollBars(Object) |
Reserved for internal use. (Inherited from _Worksheet) |
| Select(Object) |
Selects the object. (Inherited from _Worksheet) |
| SetBackgroundPicture(String) |
Sets the background graphic for a worksheet or chart. (Inherited from _Worksheet) |
| ShowAllData() |
Makes all rows of the currently filtered list visible. If AutoFilter is in use, this method changes the arrows to "All." (Inherited from _Worksheet) |
| ShowDataForm() |
Displays the data form associated with the worksheet. (Inherited from _Worksheet) |
| Spinners(Object) |
Reserved for internal use. (Inherited from _Worksheet) |
| TextBoxes(Object) |
Reserved for internal use. (Inherited from _Worksheet) |
| Unprotect(Object) |
Removes protection from a sheet or workbook. This method has no effect if the sheet or workbook isn't protected. (Inherited from _Worksheet) |
| XmlDataQuery(String, Object, Object) |
Returns a Range object that represents the cells mapped to a particular XPath. Returns Nothing if the specified XPath has not been mapped to the worksheet or if the mapped range is empty. (Inherited from _Worksheet) |
| XmlMapQuery(String, Object, Object) |
Returns a Range object that represents the cells mapped to a particular XPath. Returns Nothing if the specified XPath has not been mapped to the worksheet. (Inherited from _Worksheet) |
Events
| Activate |
Occurs when a worksheet is activated. (Inherited from DocEvents_Event) |
| BeforeDelete |
The BeforeDelete event occurs before any sheet is deleted. (Inherited from DocEvents_Event) |
| BeforeDoubleClick |
Occurs when a worksheet is double-clicked, before the default double-click action. (Inherited from DocEvents_Event) |
| BeforeRightClick |
Occurs when a worksheet is right-clicked, before the default right-click action. (Inherited from DocEvents_Event) |
| Calculate |
Occurs after the worksheet is recalculated. (Inherited from DocEvents_Event) |
| Change |
Occurs when cells on the worksheet are changed by the user or by an external link. (Inherited from DocEvents_Event) |
| Deactivate |
Occurs when the worksheet is deactivated. (Inherited from DocEvents_Event) |
| FollowHyperlink |
Occurs when you click any hyperlink on a worksheet. For application- and workbook-level events, see the SheetFollowHyperlink event. (Inherited from DocEvents_Event) |
| LensGalleryRenderComplete |
Occurs when a callout gallery’s icons (dynamic and static) have completed rendering. (Inherited from DocEvents_Event) |
| PivotTableAfterValueChange |
Occurs after a cell or range of cells inside a PivotTable are edited or recalculated (for cells that contain formulas). (Inherited from DocEvents_Event) |
| PivotTableBeforeAllocateChanges |
Occurs before changes are applied to a PivotTable. (Inherited from DocEvents_Event) |
| PivotTableBeforeCommitChanges |
Occurs before changes are committed against the OLAP data source for a PivotTable. (Inherited from DocEvents_Event) |
| PivotTableBeforeDiscardChanges |
Occurs before changes to a PivotTable are discarded. (Inherited from DocEvents_Event) |
| PivotTableChangeSync |
Occurs after changes to a PivotTable. (Inherited from DocEvents_Event) |
| PivotTableUpdate |
Occurs after a PivotTable report is updated on a worksheet. (Inherited from DocEvents_Event) |
| SelectionChange |
Occurs when the selection changes on a worksheet. (Inherited from DocEvents_Event) |
| TableUpdate |
Occurs after a Query table connected to the Data Model is updated on a worksheet. (Inherited from DocEvents_Event) |