Share via


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

Top

Methods

  Name Description
Public method _CheckSpelling Reserved for internal use.
Public method _Evaluate Reserved for internal use.
Public method _PasteSpecial Reserved for internal use.
Public method _PrintOut Reserved for internal use.
Public method _Protect Reserved for internal use.
Public method _SaveAs Reserved for internal use.
Public method Activate Makes the current sheet the active sheet. Equivalent to clicking the sheet's tab.
Public method Arcs Reserved for internal use.
Public method Buttons Reserved for internal use.
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.
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.
Public method CheckBoxes Reserved for internal use.
Public method CheckSpelling Checks the spelling of an object. This form has no return value; Microsoft Excel displays the Spelling dialog box.
Public method CircleInvalid Circles invalid entries on the worksheet.
Public method ClearArrows Clears the tracer arrows from the worksheet. Tracer arrows are added by using the auditing feature.
Public method ClearCircles Clears circles from invalid entries on the worksheet.
Public method Copy Copies the sheet to another location in the workbook.
Public method Delete Deletes the object.
Public method DrawingObjects Reserved for internal use.
Public method Drawings Reserved for internal use.
Public method DropDowns Reserved for internal use.
Public method Evaluate Converts a Microsoft Excel name to an object or a value.
Public method ExportAsFixedFormat Exports to a file of the specified format.
Public method GroupBoxes Reserved for internal use.
Public method GroupObjects Reserved for internal use.
Public method Labels Reserved for internal use.
Public method Lines Reserved for internal use.
Public method ListBoxes Reserved for internal use.
Public method Move Moves the sheet to another location in the workbook
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.
Public method OptionButtons Reserved for internal use.
Public method Ovals Reserved for internal use.
Public method Paste Pastes the contents of the Clipboard onto the sheet.
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.
Public method Pictures Reserved for internal use.
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.
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.
Public method PrintOut Prints the object.
Public method PrintOutEx Reserved for internal use.
Public method PrintPreview Shows a preview of the object as it would look when printed.
Public method Protect Protects a worksheet so that it cannot be modified.
Public method Rectangles Reserved for internal use.
Public method ResetAllPageBreaks Resets all page breaks on the specified worksheet.
Public method SaveAs Saves changes to the chart or worksheet in a different file.
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.
Public method ScrollBars Reserved for internal use.
Public method Select Selects the object.
Public method SetBackgroundPicture Sets the background graphic for a worksheet or chart.
Public method ShowAllData Makes all rows of the currently filtered list visible. If AutoFilter is in use, this method changes the arrows to "All."
Public method ShowDataForm Displays the data form associated with the worksheet.
Public method Spinners Reserved for internal use.
Public method TextBoxes Reserved for internal use.
Public method Unprotect Removes protection from a sheet or workbook. This method has no effect if the sheet or workbook isn't protected.
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.
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.

Top

See Also

Reference

_Worksheet Interface

Microsoft.Office.Interop.Excel Namespace