Excel.Workbook class
Workbook is the top level object which contains related workbook objects such as worksheets, tables, and ranges. To learn more about the workbook object model, read Work with workbooks using the Excel JavaScript API.
- Extends
Remarks
Properties
| application | Represents the Excel application instance that contains this workbook. |
| bindings | Represents a collection of bindings that are part of the workbook. |
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| functions | Represents a collection of worksheet functions that can be used for computation. |
| names | Represents a collection of workbook-scoped named items (named ranges and constants). |
| pivot |
Represents a collection of PivotTables associated with the workbook. |
| settings | Represents a collection of settings associated with the workbook. |
| tables | Represents a collection of tables associated with the workbook. |
| worksheets | Represents a collection of worksheets associated with the workbook. |
Methods
| get |
Gets the currently selected single range from the workbook. If there are multiple ranges selected, this method will throw an error. |
| 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 |
| set(properties, options) | Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. |
| set(properties) | Sets multiple properties on the object at the same time, based on an existing loaded object. |
| toJSON() | Overrides the JavaScript |
Events
| on |
Occurs when the selection in the document is changed. |
Property Details
application
Represents the Excel application instance that contains this workbook.
readonly application: Excel.Application;Property Value
Remarks
bindings
Represents a collection of bindings that are part of the workbook.
readonly bindings: Excel.BindingCollection;Property Value
Remarks
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
functions
Represents a collection of worksheet functions that can be used for computation.
readonly functions: Excel.Functions;Property Value
Remarks
names
Represents a collection of workbook-scoped named items (named ranges and constants).
readonly names: Excel.NamedItemCollection;Property Value
Remarks
pivotTables
Represents a collection of PivotTables associated with the workbook.
readonly pivotTables: Excel.PivotTableCollection;Property Value
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-get-pivottables.yaml
await Excel.run(async (context) => {
// Get the names of all the PivotTables in the workbook.
const pivotTables = context.workbook.pivotTables;
pivotTables.load("name");
await context.sync();
// Display the names in the console.
console.log("PivotTables in the workbook:")
pivotTables.items.forEach((pivotTable) => {
console.log(`\t${pivotTable.name}`);
});
});
settings
Represents a collection of settings associated with the workbook.
readonly settings: Excel.SettingCollection;Property Value
Remarks
tables
Represents a collection of tables associated with the workbook.
readonly tables: Excel.TableCollection;Property Value
Remarks
worksheets
Represents a collection of worksheets associated with the workbook.
readonly worksheets: Excel.WorksheetCollection;Property Value
Remarks
Method Details
getSelectedRange()
Gets the currently selected single range from the workbook. If there are multiple ranges selected, this method will throw an error.
getSelectedRange(): Excel.Range;Returns
Remarks
Examples
await Excel.run(async (context) => {
const selectedRange = context.workbook.getSelectedRange();
selectedRange.load('address');
await context.sync();
console.log(selectedRange.address);
});
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.WorkbookLoadOptions): Excel.Workbook;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.Workbook;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?: {
select?: string;
expand?: string;
}): Excel.Workbook;Parameters
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
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
set(properties, options)
Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties: Interfaces.WorkbookUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameters
- properties
- Excel.Interfaces.WorkbookUpdateData
A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
- options
- OfficeExtension.UpdateOptions
Provides an option to suppress errors if the properties object tries to set any read-only properties.
Returns
void
set(properties)
Sets multiple properties on the object at the same time, based on an existing loaded object.
set(properties: Excel.Workbook): void;Parameters
- properties
- Excel.Workbook
Returns
void
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 is passed to it.) Whereas the original Excel.Workbook object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.WorkbookData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Excel.Interfaces.WorkbookData;Returns
Event Details
onSelectionChanged
Occurs when the selection in the document is changed.
readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.SelectionChangedEventArgs>;Event Type
Remarks
Office Add-ins