Worksheet Object Members

  • Article
Excel Developer Reference

Represents a worksheet.

Methods

  Name Description
Bb225772.methods(en-us,office.12).gif Activate Makes the current sheet the active sheet.
Bb225772.methods(en-us,office.12).gif 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.
Bb225772.methods(en-us,office.12).gif 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.
Bb225772.methods(en-us,office.12).gif CheckSpelling Checks the spelling of an object.
Bb225772.methods(en-us,office.12).gif CircleInvalid Circles invalid entries on the worksheet.
Bb225772.methods(en-us,office.12).gif ClearArrows Clears the tracer arrows from the worksheet. Tracer arrows are added by using the auditing feature.
Bb225772.methods(en-us,office.12).gif ClearCircles Clears circles from invalid entries on the worksheet.
Bb225772.methods(en-us,office.12).gif Copy Copies the sheet to another location in the workbook.
Bb225772.methods(en-us,office.12).gif Delete Deletes the object.
Bb225772.methods(en-us,office.12).gif Evaluate Converts a Microsoft Excel name to an object or a value.
Bb225772.methods(en-us,office.12).gif ExportAsFixedFormat Exports to a file of the specified format.
Bb225772.methods(en-us,office.12).gif Move Moves the sheet to another location in the workbook.
Bb225772.methods(en-us,office.12).gif 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.
Bb225772.methods(en-us,office.12).gif Paste Pastes the contents of the Clipboard onto the sheet.
Bb225772.methods(en-us,office.12).gif 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.
Bb225772.methods(en-us,office.12).gif 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.
Bb225772.methods(en-us,office.12).gif PivotTableWizard Creates a new PivotTable report. 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.
Bb225772.methods(en-us,office.12).gif PrintOut Prints the object.
Bb225772.methods(en-us,office.12).gif PrintPreview Shows a preview of the object as it would look when printed.
Bb225772.methods(en-us,office.12).gif Protect Protects a worksheet so that it cannot be modified.
Bb225772.methods(en-us,office.12).gif ResetAllPageBreaks Resets all page breaks on the specified worksheet.
Bb225772.methods(en-us,office.12).gif SaveAs Saves changes to the chart or worksheet in a different file.
Bb225772.methods(en-us,office.12).gif Scenarios Returns an object that represents either a single scenario (a Scenario object) or a collection of scenarios (a Scenarios object) on the worksheet.
Bb225772.methods(en-us,office.12).gif Select Selects the object.
Bb225772.methods(en-us,office.12).gif SetBackgroundPicture Sets the background graphic for a worksheet.
Bb225772.methods(en-us,office.12).gif ShowAllData Makes all rows of the currently filtered list visible. If AutoFilter is in use, this method changes the arrows to "All."
Bb225772.methods(en-us,office.12).gif ShowDataForm Displays the data form associated with the worksheet.
Bb225772.methods(en-us,office.12).gif Unprotect Removes protection from a sheet or workbook. This method has no effect if the sheet or workbook isn't protected.
Bb225772.methods(en-us,office.12).gif 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.
Bb225772.methods(en-us,office.12).gif 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.

Properties

  Name Description
Bb225772.properties(en-us,office.12).gif 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.
Bb225772.properties(en-us,office.12).gif AutoFilter Returns an AutoFilter object if filtering is on. Read-only.
Bb225772.properties(en-us,office.12).gif 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.
Bb225772.properties(en-us,office.12).gif Cells Returns a Range object that represents all the cells on the worksheet (not just the cells that are currently in use.
Bb225772.properties(en-us,office.12).gif 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.
Bb225772.properties(en-us,office.12).gif CodeName Returns the code name for the object. Read-only String.
Bb225772.properties(en-us,office.12).gif Columns Returns a Range object that represents all the columns on the active worksheet. If the active document isn't a worksheet, the Columns property fails.
Bb225772.properties(en-us,office.12).gif Comments Returns a Comments collection that represents all the comments for the specified worksheet. Read-only.
Bb225772.properties(en-us,office.12).gif ConsolidationFunction Returns the function code used for the current consolidation. Can be one of the constants of XlConsolidationFunction. Read-only Long.
Bb225772.properties(en-us,office.12).gif 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 Variant.
Bb225772.properties(en-us,office.12).gif 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 Variant.
Bb225772.properties(en-us,office.12).gif Creator Returns a 32-bit integer that indicates the application in which this object was created. Read-only Long.
Bb225772.properties(en-us,office.12).gif CustomProperties Returns a CustomProperties object representing the identifier information associated with a worksheet.
Bb225772.properties(en-us,office.12).gif DisplayPageBreaks True if page breaks (both automatic and manual) on the specified worksheet are displayed. Read/write Boolean.
Bb225772.properties(en-us,office.12).gif DisplayRightToLeft True if the specified worksheet 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.
Bb225772.properties(en-us,office.12).gif EnableAutoFilter True if AutoFilter arrows are enabled when user-interface-only protection is turned on. Read/write Boolean.
Bb225772.properties(en-us,office.12).gif EnableCalculation True if Microsoft Excel automatically recalculates the worksheet when necessary. False if Excel doesn't recalculate the sheet. Read/write Boolean.
Bb225772.properties(en-us,office.12).gif EnableFormatConditionsCalculation Returms or sets if conditional formats will will occur automatically as needed. Read/write Boolean.
Bb225772.properties(en-us,office.12).gif EnableOutlining True if outlining symbols are enabled when user-interface-only protection is turned on. Read/write Boolean.
Bb225772.properties(en-us,office.12).gif EnablePivotTable True if PivotTable controls and actions are enabled when user-interface-only protection is turned on. Read/write Boolean.
Bb225772.properties(en-us,office.12).gif EnableSelection Returns or sets what can be selected on the sheet. Read/write XlEnableSelection.
Bb225772.properties(en-us,office.12).gif FilterMode True if the worksheet is in the filter mode. Read-only Boolean.
Bb225772.properties(en-us,office.12).gif HPageBreaks Returns an HPageBreaks collection that represents the horizontal page breaks on the sheet. Read-only.
Bb225772.properties(en-us,office.12).gif Hyperlinks Returns a Hyperlinks collection that represents the hyperlinks for the worksheet.
Bb225772.properties(en-us,office.12).gif Index Returns a Long value that represents the index number of the object within the collection of similar objects.
Bb225772.properties(en-us,office.12).gif ListObjects Returns a collection of ListObject objects in the worksheet. Read-only ListObjects collection.
Bb225772.properties(en-us,office.12).gif MailEnvelope Rrepresents an e-mail header for a document.
Bb225772.properties(en-us,office.12).gif Name Returns or sets a String value representing the name of the object.
Bb225772.properties(en-us,office.12).gif Names Returns a Names collection that represents all the worksheet-specific names (names defined with the "WorksheetName!" prefix). Read-only Names object.
Bb225772.properties(en-us,office.12).gif Next Returns a Worksheet object that represents the next sheet.
Bb225772.properties(en-us,office.12).gif Outline Returns an Outline object that represents the outline for the specified worksheet. Read-only.
Bb225772.properties(en-us,office.12).gif PageSetup Returns a PageSetup object that contains all the page setup settings for the specified object. Read-only.
Bb225772.properties(en-us,office.12).gif Parent Returns the parent object for the specified object. Read-only.
Bb225772.properties(en-us,office.12).gif Previous Returns a Worksheet object that represents the next sheet.
Bb225772.properties(en-us,office.12).gif ProtectContents True if the contents of the sheet are protected. This protects the individual cells. To turn on content protection, use the Protect method with the Contents argument set to True. Read-only Boolean.
Bb225772.properties(en-us,office.12).gif ProtectDrawingObjects True if shapes are protected. To turn on shape protection, use the Protect method with the DrawingObjects argument set to True. Read-only Boolean.
Bb225772.properties(en-us,office.12).gif Protection Returns a Protection object that represents the protection options of the worksheet.
Bb225772.properties(en-us,office.12).gif 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.
Bb225772.properties(en-us,office.12).gif ProtectScenarios True if the worksheet scenarios are protected. Read-only Boolean.
Bb225772.properties(en-us,office.12).gif QueryTables Returns the QueryTables collection that represents all the query tables on the specified worksheet. Read-only.
Bb225772.properties(en-us,office.12).gif Range Returns a Range object that represents a cell or a range of cells.
Bb225772.properties(en-us,office.12).gif Rows Returns a Range object that represents all the rows on the specified worksheet. Read-only Range object.
Bb225772.properties(en-us,office.12).gif 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.
Bb225772.properties(en-us,office.12).gif Shapes Returns a Shapes collection that represents all the shapes on the worksheet. Read-only.
Bb225772.properties(en-us,office.12).gif SmartTags Returns a SmartTags object representing the identifier for the specified cell.
Bb225772.properties(en-us,office.12).gif Sort Returns the sorted values in the current worksheet. Read-only.
Bb225772.properties(en-us,office.12).gif StandardHeight Returns the standard (default) height of all the rows in the worksheet, in points. Read-only Double.
Bb225772.properties(en-us,office.12).gif StandardWidth Returns or sets the standard (default) width of all the columns in the worksheet. Read/write Double.
Bb225772.properties(en-us,office.12).gif Tab Returns a Tab object for a worksheet.
Bb225772.properties(en-us,office.12).gif TransitionExpEval True if Microsoft Excel uses Lotus 1-2-3 expression evaluation rules for the worksheet. Read/write Boolean.
Bb225772.properties(en-us,office.12).gif TransitionFormEntry True if Microsoft Excel uses Lotus 1-2-3 formula entry rules for the worksheet. Read/write Boolean.
Bb225772.properties(en-us,office.12).gif Type Returns an XlSheetType value that represents the worksheet type.
Bb225772.properties(en-us,office.12).gif UsedRange Returns a Range object that represents the used range on the specified worksheet. Read-only.
Bb225772.properties(en-us,office.12).gif Visible Returns or sets an XlSheetVisibility value that determines whether the object is visible.
Bb225772.properties(en-us,office.12).gif VPageBreaks Returns a VPageBreaks collection that represents the vertical page breaks on the sheet. Read-only.

Events

  Name Description
Bb225772.events(en-us,office.12).gif Activate Occurs when a workbook, worksheet, chart sheet, or embedded chart is activated.
Bb225772.events(en-us,office.12).gif BeforeDoubleClick Occurs when a worksheet is double-clicked, before the default double-click action.
Bb225772.events(en-us,office.12).gif BeforeRightClick Occurs when a worksheet is right-clicked, before the default right-click action.
Bb225772.events(en-us,office.12).gif Calculate Occurs after the worksheet is recalculated, for the Worksheet object.
Bb225772.events(en-us,office.12).gif Change Occurs when cells on the worksheet are changed by the user or by an external link.
Bb225772.events(en-us,office.12).gif Deactivate Occurs when the chart, worksheet, or workbook is deactivated.
Bb225772.events(en-us,office.12).gif FollowHyperlink Occurs when you click any hyperlink on a worksheet. For application- and workbook-level events, see the SheetFollowHyperlink event.
Bb225772.events(en-us,office.12).gif PivotTableUpdate Occurs after a PivotTable report is updated on a worksheet.
Bb225772.events(en-us,office.12).gif SelectionChange Occurs when the selection changes on a worksheet.