Excel.WorksheetCollection class
Represents a collection of worksheet objects that are part of the workbook.
- Extends
Remarks
[Api set: ExcelApi 1.1]
Properties
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| items | Gets the loaded child items in this collection. |
Methods
| add(name) | Adds a new worksheet to the workbook. The worksheet will be added at the end of existing worksheets. If you wish to activate the newly added worksheet, call |
| get |
Gets the currently active worksheet in the workbook. |
| get |
Gets the number of worksheets in the collection. |
| get |
Gets the first worksheet in the collection. |
| get |
Gets a worksheet object using its name or ID. |
| get |
Gets a worksheet object using its name or ID. If the worksheet does not exist, then this method returns an object with its |
| get |
Gets the last worksheet in the collection. |
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| toJSON() | Overrides the JavaScript |
Events
| on |
Occurs when any worksheet in the workbook is activated. |
| on |
Occurs when a new worksheet is added to the workbook. |
| on |
Occurs when any worksheet in the workbook is calculated. |
| on |
Occurs when any worksheet in the workbook is changed. |
| on |
Occurs when one or more columns have been sorted. This happens as the result of a left-to-right sort operation. |
| on |
Occurs when any worksheet in the workbook is deactivated. |
| on |
Occurs when a worksheet is deleted from the workbook. |
| on |
Occurs when any worksheet in the workbook has a format changed. |
| on |
Occurs when one or more formulas are changed in any worksheet of this collection. This event is for when the formula itself changes, not the data value resulting from the formula's calculation. |
| on |
Occurs when a worksheet is moved within a workbook. This event only triggers when a worksheet is directly moved within a workbook. This event doesn't trigger when the position of a worksheet is indirectly changed, such as when a new worksheet is inserted and causes existing worksheets to change positions. |
| on |
Occurs when the worksheet name is changed in the worksheet collection. |
| on |
Occurs when the worksheet protection state is changed. |
| on |
Occurs when the hidden state of one or more rows has changed on a specific worksheet. |
| on |
Occurs when one or more rows have been sorted. This happens as the result of a top-to-bottom sort operation. |
| on |
Occurs when the selection changes on any worksheet. |
| on |
Occurs when left-clicked/tapped operation happens in the worksheet collection. This event will not be fired when clicking in the following cases: - The user drags the mouse for multi-selection. - The user selects a cell in the mode when cell arguments are selected for formula references. |
| on |
Occurs when the worksheet visibility is changed in the worksheet collection. |
Property Details
context
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Property Value
items
Gets the loaded child items in this collection.
readonly items: Excel.Worksheet[];Property Value
Method Details
add(name)
Adds a new worksheet to the workbook. The worksheet will be added at the end of existing worksheets. If you wish to activate the newly added worksheet, call .activate() on it.
add(name?: string): Excel.Worksheet;Parameters
- name
-
string
Optional. The name of the worksheet to be added. If specified, the name should be unique. If not specified, Excel determines the name of the new worksheet.
Returns
Remarks
[Api set: ExcelApi 1.1]
getActiveWorksheet()
Gets the currently active worksheet in the workbook.
getActiveWorksheet(): Excel.Worksheet;Returns
Remarks
[Api set: ExcelApi 1.1]
getCount(visibleOnly)
Gets the number of worksheets in the collection.
getCount(visibleOnly?: boolean): OfficeExtension.ClientResult<number>;Parameters
- visibleOnly
-
boolean
Optional. If true, considers only visible worksheets, skipping over any hidden ones.
Returns
OfficeExtension.ClientResult<number>
Remarks
[Api set: ExcelApi 1.4]
getFirst(visibleOnly)
Gets the first worksheet in the collection.
getFirst(visibleOnly?: boolean): Excel.Worksheet;Parameters
- visibleOnly
-
boolean
Optional. If true, considers only visible worksheets, skipping over any hidden ones.
Returns
Remarks
[Api set: ExcelApi 1.5]
getItem(key)
Gets a worksheet object using its name or ID.
getItem(key: string): Excel.Worksheet;Parameters
- key
-
string
The name or ID of the worksheet.
Returns
Remarks
[Api set: ExcelApi 1.1]
getItemOrNullObject(key)
Gets a worksheet object using its name or ID. If the worksheet does not exist, then this method returns an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
getItemOrNullObject(key: string): Excel.Worksheet;Parameters
- key
-
string
The name or ID of the worksheet.
Returns
Remarks
[Api set: ExcelApi 1.4]
getLast(visibleOnly)
Gets the last worksheet in the collection.
getLast(visibleOnly?: boolean): Excel.Worksheet;Parameters
- visibleOnly
-
boolean
Optional. If true, considers only visible worksheets, skipping over any hidden ones.
Returns
Remarks
[Api set: ExcelApi 1.5]
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: Excel.Interfaces.WorksheetCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.WorksheetCollection;Parameters
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): Excel.WorksheetCollection;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.WorksheetCollection;Parameters
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
toJSON()
Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Excel.WorksheetCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.WorksheetCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
toJSON(): Excel.Interfaces.WorksheetCollectionData;Returns
Event Details
onActivated
Occurs when any worksheet in the workbook is activated.
readonly onActivated: OfficeExtension.EventHandlers<Excel.WorksheetActivatedEventArgs>;Event Type
Remarks
[Api set: ExcelApi 1.7]
onAdded
Occurs when a new worksheet is added to the workbook.
readonly onAdded: OfficeExtension.EventHandlers<Excel.WorksheetAddedEventArgs>;Event Type
Remarks
[Api set: ExcelApi 1.7]
onCalculated
Occurs when any worksheet in the workbook is calculated.
readonly onCalculated: OfficeExtension.EventHandlers<Excel.WorksheetCalculatedEventArgs>;Event Type
Remarks
[Api set: ExcelApi 1.8]
onChanged
Occurs when any worksheet in the workbook is changed.
readonly onChanged: OfficeExtension.EventHandlers<Excel.WorksheetChangedEventArgs>;Event Type
Remarks
[Api set: ExcelApi 1.9]
onColumnSorted
Occurs when one or more columns have been sorted. This happens as the result of a left-to-right sort operation.
readonly onColumnSorted: OfficeExtension.EventHandlers<Excel.WorksheetColumnSortedEventArgs>;Event Type
Remarks
[Api set: ExcelApi 1.10]
onDeactivated
Occurs when any worksheet in the workbook is deactivated.
readonly onDeactivated: OfficeExtension.EventHandlers<Excel.WorksheetDeactivatedEventArgs>;Event Type
Remarks
[Api set: ExcelApi 1.7]
onDeleted
Occurs when a worksheet is deleted from the workbook.
readonly onDeleted: OfficeExtension.EventHandlers<Excel.WorksheetDeletedEventArgs>;Event Type
Remarks
[Api set: ExcelApi 1.7]
onFormatChanged
Occurs when any worksheet in the workbook has a format changed.
readonly onFormatChanged: OfficeExtension.EventHandlers<Excel.WorksheetFormatChangedEventArgs>;Event Type
Remarks
[Api set: ExcelApi 1.9]
onFormulaChanged
Occurs when one or more formulas are changed in any worksheet of this collection. This event is for when the formula itself changes, not the data value resulting from the formula's calculation.
readonly onFormulaChanged: OfficeExtension.EventHandlers<Excel.WorksheetFormulaChangedEventArgs>;Event Type
Remarks
[Api set: ExcelApi 1.13]
onMoved
Occurs when a worksheet is moved within a workbook. This event only triggers when a worksheet is directly moved within a workbook. This event doesn't trigger when the position of a worksheet is indirectly changed, such as when a new worksheet is inserted and causes existing worksheets to change positions.
readonly onMoved: OfficeExtension.EventHandlers<Excel.WorksheetMovedEventArgs>;Event Type
Remarks
[Api set: ExcelApi 1.17]
onNameChanged
Occurs when the worksheet name is changed in the worksheet collection.
readonly onNameChanged: OfficeExtension.EventHandlers<Excel.WorksheetNameChangedEventArgs>;Event Type
Remarks
[Api set: ExcelApi 1.17]
onProtectionChanged
Occurs when the worksheet protection state is changed.
readonly onProtectionChanged: OfficeExtension.EventHandlers<Excel.WorksheetProtectionChangedEventArgs>;Event Type
Remarks
[Api set: ExcelApi 1.14]
onRowHiddenChanged
Occurs when the hidden state of one or more rows has changed on a specific worksheet.
readonly onRowHiddenChanged: OfficeExtension.EventHandlers<Excel.WorksheetRowHiddenChangedEventArgs>;Event Type
Remarks
[Api set: ExcelApi 1.11]
onRowSorted
Occurs when one or more rows have been sorted. This happens as the result of a top-to-bottom sort operation.
readonly onRowSorted: OfficeExtension.EventHandlers<Excel.WorksheetRowSortedEventArgs>;Event Type
Remarks
[Api set: ExcelApi 1.10]
onSelectionChanged
Occurs when the selection changes on any worksheet.
readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.WorksheetSelectionChangedEventArgs>;Event Type
Remarks
[Api set: ExcelApi 1.9]
onSingleClicked
Occurs when left-clicked/tapped operation happens in the worksheet collection. This event will not be fired when clicking in the following cases: - The user drags the mouse for multi-selection. - The user selects a cell in the mode when cell arguments are selected for formula references.
readonly onSingleClicked: OfficeExtension.EventHandlers<Excel.WorksheetSingleClickedEventArgs>;Event Type
Remarks
[Api set: ExcelApi 1.10]
onVisibilityChanged
Occurs when the worksheet visibility is changed in the worksheet collection.
readonly onVisibilityChanged: OfficeExtension.EventHandlers<Excel.WorksheetVisibilityChangedEventArgs>;Event Type
Remarks
[Api set: ExcelApi 1.17]