Worksheet Object Members

Article
06/14/2014

Excel Developer Reference

Represents a worksheet.

Methods

	Name	Description
	Activate	Makes the current sheet the active sheet.
	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.
	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.
	CheckSpelling	Checks the spelling of an object.
	CircleInvalid	Circles invalid entries on the worksheet.
	ClearArrows	Clears the tracer arrows from the worksheet. Tracer arrows are added by using the auditing feature.
	ClearCircles	Clears circles from invalid entries on the worksheet.
	Copy	Copies the sheet to another location in the workbook.
	Delete	Deletes the object.
	Evaluate	Converts a Microsoft Excel name to an object or a value.
	ExportAsFixedFormat	Exports to a file of the specified format.
	Move	Moves the sheet to another location in the workbook.
	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.
	Paste	Pastes the contents of the Clipboard onto the sheet.
	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.
	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.
	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.
	PrintOut	Prints the object.
	PrintPreview	Shows a preview of the object as it would look when printed.
	Protect	Protects a worksheet so that it cannot be modified.
	ResetAllPageBreaks	Resets all page breaks on the specified worksheet.
	SaveAs	Saves changes to the chart or worksheet in a different file.
	Scenarios	Returns an object that represents either a single scenario (a Scenario object) or a collection of scenarios (a Scenarios object) on the worksheet.
	Select	Selects the object.
	SetBackgroundPicture	Sets the background graphic for a worksheet.
	ShowAllData	Makes all rows of the currently filtered list visible. If AutoFilter is in use, this method changes the arrows to "All."
	ShowDataForm	Displays the data form associated with the worksheet.
	Unprotect	Removes protection from a sheet or workbook. This method has no effect if the sheet or workbook isn't protected.
	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.
	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
	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.
	AutoFilter	Returns an AutoFilter object if filtering is on. Read-only.
	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.
	Cells	Returns a Range object that represents all the cells on the worksheet (not just the cells that are currently in use.
	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.
	CodeName	Returns the code name for the object. Read-only String.
	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.
	Comments	Returns a Comments collection that represents all the comments for the specified worksheet. Read-only.
	ConsolidationFunction	Returns the function code used for the current consolidation. Can be one of the constants of XlConsolidationFunction. Read-only Long.
	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.
	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.
	Creator	Returns a 32-bit integer that indicates the application in which this object was created. Read-only Long.
	CustomProperties	Returns a CustomProperties object representing the identifier information associated with a worksheet.
	DisplayPageBreaks	True if page breaks (both automatic and manual) on the specified worksheet are displayed. Read/write Boolean.
	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.
	EnableAutoFilter	True if AutoFilter arrows are enabled when user-interface-only protection is turned on. Read/write Boolean.
	EnableCalculation	True if Microsoft Excel automatically recalculates the worksheet when necessary. False if Excel doesn't recalculate the sheet. Read/write Boolean.
	EnableFormatConditionsCalculation	Returms or sets if conditional formats will will occur automatically as needed. Read/write Boolean.
	EnableOutlining	True if outlining symbols are enabled when user-interface-only protection is turned on. Read/write Boolean.
	EnablePivotTable	True if PivotTable controls and actions are enabled when user-interface-only protection is turned on. Read/write Boolean.
	EnableSelection	Returns or sets what can be selected on the sheet. Read/write XlEnableSelection.
	FilterMode	True if the worksheet is in the filter mode. Read-only Boolean.
	HPageBreaks	Returns an HPageBreaks collection that represents the horizontal page breaks on the sheet. Read-only.
	Hyperlinks	Returns a Hyperlinks collection that represents the hyperlinks for the worksheet.
	Index	Returns a Long value that represents the index number of the object within the collection of similar objects.
	ListObjects	Returns a collection of ListObject objects in the worksheet. Read-only ListObjects collection.
	MailEnvelope	Rrepresents an e-mail header for a document.
	Name	Returns or sets a String value representing the name of the object.
	Names	Returns a Names collection that represents all the worksheet-specific names (names defined with the "WorksheetName!" prefix). Read-only Names object.
	Next	Returns a Worksheet object that represents the next sheet.
	Outline	Returns an Outline object that represents the outline for the specified worksheet. Read-only.
	PageSetup	Returns a PageSetup object that contains all the page setup settings for the specified object. Read-only.
	Parent	Returns the parent object for the specified object. Read-only.
	Previous	Returns a Worksheet object that represents the next sheet.
	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.
	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.
	Protection	Returns a Protection object that represents the protection options of the worksheet.
	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.
	ProtectScenarios	True if the worksheet scenarios are protected. Read-only Boolean.
	QueryTables	Returns the QueryTables collection that represents all the query tables on the specified worksheet. Read-only.
	Range	Returns a Range object that represents a cell or a range of cells.
	Rows	Returns a Range object that represents all the rows on the specified worksheet. Read-only Range object.
	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.
	Shapes	Returns a Shapes collection that represents all the shapes on the worksheet. Read-only.
	SmartTags	Returns a SmartTags object representing the identifier for the specified cell.
	Sort	Returns the sorted values in the current worksheet. Read-only.
	StandardHeight	Returns the standard (default) height of all the rows in the worksheet, in points. Read-only Double.
	StandardWidth	Returns or sets the standard (default) width of all the columns in the worksheet. Read/write Double.
	Tab	Returns a Tab object for a worksheet.
	TransitionExpEval	True if Microsoft Excel uses Lotus 1-2-3 expression evaluation rules for the worksheet. Read/write Boolean.
	TransitionFormEntry	True if Microsoft Excel uses Lotus 1-2-3 formula entry rules for the worksheet. Read/write Boolean.
	Type	Returns an XlSheetType value that represents the worksheet type.
	UsedRange	Returns a Range object that represents the used range on the specified worksheet. Read-only.
	Visible	Returns or sets an XlSheetVisibility value that determines whether the object is visible.
	VPageBreaks	Returns a VPageBreaks collection that represents the vertical page breaks on the sheet. Read-only.

Events

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

Share via

Worksheet Object Members

Additional resources