Worksheet Members

Include Protected Members
Include Inherited Members

Represents a worksheet.

The Worksheet type exposes the following members.

Properties

  Name Description
Public property _CodeName Reserved for internal use. (Inherited from _Worksheet.)
Public property _DisplayRightToLeft Reserved for internal use. (Inherited from _Worksheet.)
Public property 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.)
Public property AutoFilter Returns an AutoFilter object if filtering is on. Returns Nothing if filtering is off. Read-only. (Inherited from _Worksheet.)
Public property 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.)
Public property 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.)
Public property 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.)
Public property CodeName Returns the code name for the object. Read-only String. (Inherited from _Worksheet.)
Public property Columns Returns a Range object that represents all the columns on the specified worksheet. Read-only. (Inherited from _Worksheet.)
Public property Comments Returns a Comments collection that represents all the comments for the specified worksheet. Read-only. (Inherited from _Worksheet.)
Public property ConsolidationFunction Returns the function code used for the current consolidation. Can be one of the XlConsolidationFunction constants. Read-only. (Inherited from _Worksheet.)
Public property 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.)
Public property 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.)
Public property 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.)
Public property CustomProperties Returns a CustomProperties object representing the identifier information associated with a worksheet. (Inherited from _Worksheet.)
Public property DisplayAutomaticPageBreaks Reserved for internal use. (Inherited from _Worksheet.)
Public property DisplayPageBreaks True if page breaks (both automatic and manual) on the specified worksheet are displayed. Read/write Boolean. (Inherited from _Worksheet.)
Public property 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.)
Public property EnableAutoFilter True if AutoFilter arrows are enabled when user-interface-only protection is turned on. Read/write Boolean. (Inherited from _Worksheet.)
Public property 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.)
Public property EnableFormatConditionsCalculation Returns or sets if conditional formats will occur automatically as needed. Read/write Boolean. (Inherited from _Worksheet.)
Public property EnableOutlining True if outlining symbols are enabled when user-interface-only protection is turned on. Read/write Boolean. (Inherited from _Worksheet.)
Public property EnablePivotTable True if PivotTable controls and actions are enabled when user-interface-only protection is turned on. Read/write Boolean. (Inherited from _Worksheet.)
Public property EnableSelection Returns or sets what can be selected on the sheet. Read/write XlEnableSelection. (Inherited from _Worksheet.)
Public property FilterMode True if the worksheet is in filter mode. Read-only Boolean. (Inherited from _Worksheet.)
Public property HPageBreaks Returns an HPageBreaks collection that represents the horizontal page breaks on the sheet. Read-only. (Inherited from _Worksheet.)
Public property Hyperlinks Returns a Hyperlinks collection that represents the hyperlinks for the range or worksheet. (Inherited from _Worksheet.)
Public property Index Returns the index number of the object within the collection of similar objects. Read-only Integer. (Inherited from _Worksheet.)
Public property ListObjects Returns a collection of ListObject objects in the worksheet. Read-only ListObjects collection. (Inherited from _Worksheet.)
Public property MailEnvelope Represents an e-mail header for a document. (Inherited from _Worksheet.)
Public property Name Returns or sets the name of the object. Read/write String. (Inherited from _Worksheet.)
Public property 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.)
Public property Next Returns a Chart, Range, or Worksheet object that represents the next sheet or cell. Read-only. (Inherited from _Worksheet.)
Public property OnCalculate Reserved for internal use. (Inherited from _Worksheet.)
Public property OnData Reserved for internal use. (Inherited from _Worksheet.)
Public property OnDoubleClick Reserved for internal use. (Inherited from _Worksheet.)
Public property OnEntry Reserved for internal use. (Inherited from _Worksheet.)
Public property OnSheetActivate Reserved for internal use. (Inherited from _Worksheet.)
Public property OnSheetDeactivate Reserved for internal use. (Inherited from _Worksheet.)
Public property Outline Returns an Outline object that represents the outline for the specified worksheet. Read-only. (Inherited from _Worksheet.)
Public property PageSetup Returns a PageSetup object that contains all the page setup settings for the specified object. Read-only. (Inherited from _Worksheet.)
Public property Parent Returns the parent object for the specified object. Read-only. (Inherited from _Worksheet.)
Public property Previous Returns a Chart, Range, or Worksheet object that represents the previous sheet or cell. Read-only. (Inherited from _Worksheet.)
Public property PrintedCommentPages Gets the number of comment pages that will be printed for the current worksheet. (Inherited from _Worksheet.)
Public property 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.)
Public property ProtectDrawingObjects True if shapes are protected. Read-only Boolean. (Inherited from _Worksheet.)
Public property Protection Returns a Protection object that represents the protection options of the worksheet. (Inherited from _Worksheet.)
Public property ProtectionMode True if user-interface-only protection is turned on. To turn on user interface protection, use the Protect method with the UserInterfaceOnly argument set to True. Read-only Boolean. (Inherited from _Worksheet.)
Public property ProtectScenarios True if the worksheet scenarios are protected. Read-only Boolean. (Inherited from _Worksheet.)
Public property QueryTables Returns the QueryTables collection that represents all the query tables on the specified worksheet. Read-only. (Inherited from _Worksheet.)
Public property Range Returns a Range object that represents a cell or a range of cells. (Inherited from _Worksheet.)
Public property Rows Returns a Range object that represents all the rows on the specified worksheet. Read-only Range object. (Inherited from _Worksheet.)
Public property 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.)
Public property 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.)
Public property Shapes Returns a Shapes object that represents all the shapes on the worksheet or chart sheet. Read-only. (Inherited from _Worksheet.)
Public property SmartTags Returns a SmartTags object representing the identifier for the specified cell. (Inherited from _Worksheet.)
Public property Sort Returns the sorted values in the current worksheet. Read-only. (Inherited from _Worksheet.)
Public property StandardHeight Returns the standard (default) height of all the rows in the worksheet in points. Read-only Double. (Inherited from _Worksheet.)
Public property StandardWidth Returns or sets the standard (default) width of all the columns in the worksheet. Read/write Double. (Inherited from _Worksheet.)
Public property Tab Returns a Tab object for a chart or a worksheet. (Inherited from _Worksheet.)
Public property TransitionExpEval True if Microsoft Excel uses Lotus 1-2-3 expression evaluation rules for the worksheet. Read/write Boolean. (Inherited from _Worksheet.)
Public property TransitionFormEntry True if Microsoft Excel uses Lotus 1-2-3 formula entry rules for the worksheet. Read/write Boolean. (Inherited from _Worksheet.)
Public property Type Returns or sets the worksheet type. Read-only XlSheetType. (Inherited from _Worksheet.)
Public property UsedRange Returns a Range object that represents the used range on the specified worksheet. Read-only. (Inherited from _Worksheet.)
Public property Visible Determines whether the object is visible. Read/write XlSheetVisibility. (Inherited from _Worksheet.)
Public property VPageBreaks Returns a VPageBreaks collection that represents the vertical page breaks on the sheet. Read-only. (Inherited from _Worksheet.)

Top

Methods

  Name Description
Public method _CheckSpelling Reserved for internal use. (Inherited from _Worksheet.)
Public method _Evaluate Reserved for internal use. (Inherited from _Worksheet.)
Public method _PasteSpecial Reserved for internal use. (Inherited from _Worksheet.)
Public method _PrintOut Reserved for internal use. (Inherited from _Worksheet.)
Public method _Protect Reserved for internal use. (Inherited from _Worksheet.)
Public method _SaveAs Reserved for internal use. (Inherited from _Worksheet.)
Public method Activate Makes the current sheet the active sheet. Equivalent to clicking the sheet's tab. (Inherited from _Worksheet.)
Public method add_Activate Reserved for internal use. (Inherited from DocEvents_Event.)
Public method add_BeforeDoubleClick Reserved for internal use. (Inherited from DocEvents_Event.)
Public method add_BeforeRightClick Reserved for internal use. (Inherited from DocEvents_Event.)
Public method add_Calculate Reserved for internal use. (Inherited from DocEvents_Event.)
Public method add_Change Reserved for internal use. (Inherited from DocEvents_Event.)
Public method add_Deactivate Reserved for internal use. (Inherited from DocEvents_Event.)
Public method add_FollowHyperlink Reserved for internal use. (Inherited from DocEvents_Event.)
Public method add_PivotTableAfterValueChange Reserved for internal use. (Inherited from DocEvents_Event.)
Public method add_PivotTableBeforeAllocateChanges Reserved for internal use. (Inherited from DocEvents_Event.)
Public method add_PivotTableBeforeCommitChanges Reserved for internal use. (Inherited from DocEvents_Event.)
Public method add_PivotTableBeforeDiscardChanges Reserved for internal use. (Inherited from DocEvents_Event.)
Public method add_PivotTableChangeSync Reserved for internal use. (Inherited from DocEvents_Event.)
Public method add_PivotTableUpdate Reserved for internal use. (Inherited from DocEvents_Event.)
Public method add_SelectionChange Reserved for internal use. (Inherited from DocEvents_Event.)
Public method Arcs Reserved for internal use. (Inherited from _Worksheet.)
Public method Buttons Reserved for internal use. (Inherited from _Worksheet.)
Public method Calculate Calculates all open workbooks, a specific worksheet in a workbook, or a specified range of cells on a worksheet, as shown in the following table. (Inherited from _Worksheet.)
Public method ChartObjects 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.)
Public method CheckBoxes Reserved for internal use. (Inherited from _Worksheet.)
Public method CheckSpelling Checks the spelling of an object. This form has no return value; Microsoft Excel displays the Spelling dialog box. (Inherited from _Worksheet.)
Public method CircleInvalid Circles invalid entries on the worksheet. (Inherited from _Worksheet.)
Public method ClearArrows Clears the tracer arrows from the worksheet. Tracer arrows are added by using the auditing feature. (Inherited from _Worksheet.)
Public method ClearCircles Clears circles from invalid entries on the worksheet. (Inherited from _Worksheet.)
Public method Copy Copies the sheet to another location in the workbook. (Inherited from _Worksheet.)
Public method Delete Deletes the object. (Inherited from _Worksheet.)
Public method DrawingObjects Reserved for internal use. (Inherited from _Worksheet.)
Public method Drawings Reserved for internal use. (Inherited from _Worksheet.)
Public method DropDowns Reserved for internal use. (Inherited from _Worksheet.)
Public method Evaluate Converts a Microsoft Excel name to an object or a value. (Inherited from _Worksheet.)
Public method ExportAsFixedFormat Exports to a file of the specified format. (Inherited from _Worksheet.)
Public method GroupBoxes Reserved for internal use. (Inherited from _Worksheet.)
Public method GroupObjects Reserved for internal use. (Inherited from _Worksheet.)
Public method Labels Reserved for internal use. (Inherited from _Worksheet.)
Public method Lines Reserved for internal use. (Inherited from _Worksheet.)
Public method ListBoxes Reserved for internal use. (Inherited from _Worksheet.)
Public method Move Moves the sheet to another location in the workbook (Inherited from _Worksheet.)
Public method OLEObjects 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.)
Public method OptionButtons Reserved for internal use. (Inherited from _Worksheet.)
Public method Ovals Reserved for internal use. (Inherited from _Worksheet.)
Public method Paste Pastes the contents of the Clipboard onto the sheet. (Inherited from _Worksheet.)
Public method PasteSpecial 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.)
Public method Pictures Reserved for internal use. (Inherited from _Worksheet.)
Public method PivotTables 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.)
Public method PivotTableWizard 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 method to add a PivotTable cache, and then create a PivotTable report based on the cache. PivotTable object. (Inherited from _Worksheet.)
Public method PrintOut Prints the object. (Inherited from _Worksheet.)
Public method PrintOutEx Reserved for internal use. (Inherited from _Worksheet.)
Public method PrintPreview Shows a preview of the object as it would look when printed. (Inherited from _Worksheet.)
Public method Protect Protects a worksheet so that it cannot be modified. (Inherited from _Worksheet.)
Public method Rectangles Reserved for internal use. (Inherited from _Worksheet.)
Public method remove_Activate Reserved for internal use. (Inherited from DocEvents_Event.)
Public method remove_BeforeDoubleClick Reserved for internal use. (Inherited from DocEvents_Event.)
Public method remove_BeforeRightClick Reserved for internal use. (Inherited from DocEvents_Event.)
Public method remove_Calculate Reserved for internal use. (Inherited from DocEvents_Event.)
Public method remove_Change Reserved for internal use. (Inherited from DocEvents_Event.)
Public method remove_Deactivate Reserved for internal use. (Inherited from DocEvents_Event.)
Public method remove_FollowHyperlink Reserved for internal use. (Inherited from DocEvents_Event.)
Public method remove_PivotTableAfterValueChange Reserved for internal use. (Inherited from DocEvents_Event.)
Public method remove_PivotTableBeforeAllocateChanges Reserved for internal use. (Inherited from DocEvents_Event.)
Public method remove_PivotTableBeforeCommitChanges Reserved for internal use. (Inherited from DocEvents_Event.)
Public method remove_PivotTableBeforeDiscardChanges Reserved for internal use. (Inherited from DocEvents_Event.)
Public method remove_PivotTableChangeSync Reserved for internal use. (Inherited from DocEvents_Event.)
Public method remove_PivotTableUpdate Reserved for internal use. (Inherited from DocEvents_Event.)
Public method remove_SelectionChange Reserved for internal use. (Inherited from DocEvents_Event.)
Public method ResetAllPageBreaks Resets all page breaks on the specified worksheet. (Inherited from _Worksheet.)
Public method SaveAs Saves changes to the chart or worksheet in a different file. (Inherited from _Worksheet.)
Public method Scenarios 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.)
Public method ScrollBars Reserved for internal use. (Inherited from _Worksheet.)
Public method Select Selects the object. (Inherited from _Worksheet.)
Public method SetBackgroundPicture Sets the background graphic for a worksheet or chart. (Inherited from _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." (Inherited from _Worksheet.)
Public method ShowDataForm Displays the data form associated with the worksheet. (Inherited from _Worksheet.)
Public method Spinners Reserved for internal use. (Inherited from _Worksheet.)
Public method TextBoxes Reserved for internal use. (Inherited from _Worksheet.)
Public method Unprotect Removes protection from a sheet or workbook. This method has no effect if the sheet or workbook isn't protected. (Inherited from _Worksheet.)
Public method XmlDataQuery 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.)
Public method XmlMapQuery 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.)

Top

Events

  Name Description
Public event Activate Occurs when a worksheet is activated. (Inherited from DocEvents_Event.)
Public event BeforeDoubleClick Occurs when a worksheet is double-clicked, before the default double-click action. (Inherited from DocEvents_Event.)
Public event BeforeRightClick Occurs when a worksheet is right-clicked, before the default right-click action. (Inherited from DocEvents_Event.)
Public event Calculate Occurs after the worksheet is recalculated. (Inherited from DocEvents_Event.)
Public event Change Occurs when cells on the worksheet are changed by the user or by an external link. (Inherited from DocEvents_Event.)
Public event Deactivate Occurs when the worksheet is deactivated. (Inherited from DocEvents_Event.)
Public 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.)
Public 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.)
Public event PivotTableBeforeAllocateChanges Occurs before changes are applied to a PivotTable. (Inherited from DocEvents_Event.)
Public event PivotTableBeforeCommitChanges Occurs before changes are committed against the OLAP data source for a PivotTable. (Inherited from DocEvents_Event.)
Public event PivotTableBeforeDiscardChanges Occurs before changes to a PivotTable are discarded. (Inherited from DocEvents_Event.)
Public event PivotTableChangeSync Occurs after changes to a PivotTable. (Inherited from DocEvents_Event.)
Public event PivotTableUpdate Occurs after a PivotTable report is updated on a worksheet. (Inherited from DocEvents_Event.)
Public event SelectionChange Occurs when the selection changes on a worksheet. (Inherited from DocEvents_Event.)

Top

See Also

Reference

Worksheet Interface

Microsoft.Office.Interop.Excel Namespace