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

[ API set: ExcelApi 1.1 ]

Properties

application

Represents the Excel application instance that contains this workbook.

autoSave

Specifies if the workbook is in AutoSave mode.

bindings

Represents a collection of bindings that are part of the workbook.

calculationEngineVersion

Returns a number about the version of Excel Calculation Engine.

chartDataPointTrack

True if all charts in the workbook are tracking the actual data points to which they are attached. False if the charts track the index of the data points.

comments

Represents a collection of comments associated with the workbook.

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

customXmlParts

Represents the collection of custom XML parts contained by this workbook.

dataConnections

Represents all data connections in the workbook.

functions

Represents a collection of worksheet functions that can be used for computation.

isDirty

Specifies if changes have been made since the workbook was last saved. You can set this property to true if you want to close a modified workbook without either saving it or being prompted to save it.

name

Gets the workbook name.

names

Represents a collection of workbook-scoped named items (named ranges and constants).

pivotTables

Represents a collection of PivotTables associated with the workbook.

pivotTableStyles

Represents a collection of PivotTableStyles associated with the workbook.

previouslySaved

Specifies if the workbook has ever been saved locally or online.

properties

Gets the workbook properties.

protection

Returns the protection object for a workbook.

queries

Returns a collection of Power Query queries that are part of the workbook.

readOnly

Returns true if the workbook is open in read-only mode.

settings

Represents a collection of settings associated with the workbook.

slicers

Represents a collection of slicers associated with the workbook.

slicerStyles

Represents a collection of SlicerStyles associated with the workbook.

styles

Represents a collection of styles associated with the workbook.

tables

Represents a collection of tables associated with the workbook.

tableStyles

Represents a collection of TableStyles associated with the workbook.

timelineStyles

Represents a collection of TimelineStyles associated with the workbook.

usePrecisionAsDisplayed

True if calculations in this workbook will be done using only the precision of the numbers as they're displayed. Data will permanently lose accuracy when switching this property from false to true.

worksheets

Represents a collection of worksheets associated with the workbook.

Methods

close(closeBehavior)

Close current workbook.

close(closeBehaviorString)

Close current workbook.

getActiveCell()

Gets the currently active cell from the workbook.

getActiveChart()

Gets the currently active chart in the workbook. If there is no active chart, an ItemNotFound exception is thrown.

getActiveChartOrNullObject()

Gets the currently active chart in the workbook. If there is no active chart, then this method returns an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.

getActiveSlicer()

Gets the currently active slicer in the workbook. If there is no active slicer, an ItemNotFound exception is thrown.

getActiveSlicerOrNullObject()

Gets the currently active slicer in the workbook. If there is no active slicer, then this method returns an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.

getIsActiveCollabSession()

Returns true if the workbook is being edited by multiple users (through co-authoring). Please be aware there might be some delay between when the workbook status changes and when the changes are reflected on the result of the method.

getLinkedEntityCellValue(linkedEntityCellValueId)

Returns a LinkedEntityCellValue based on the provided LinkedEntityId.

getSelectedRange()

Gets the currently selected single range from the workbook. If there are multiple ranges selected, this method will throw an error.

getSelectedRanges()

Gets the currently selected one or more ranges from the workbook. Unlike getSelectedRange(), this method returns a RangeAreas object that represents all the selected ranges.

insertWorksheetsFromBase64(base64File, options)

Inserts the specified worksheets from a source workbook into the current workbook.

Note*: This API is currently only supported for Office on Windows, Mac, and the web.

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

save(saveBehavior)

Save current workbook.

save(saveBehaviorString)

Save current workbook.

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 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.

Events

onActivated

Occurs when the workbook is activated. Note: This event will not fire when the workbook is opened.

onAutoSaveSettingChanged

Occurs when the AutoSave setting is changed on the workbook.

onSelectionChanged

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

[ API set: ExcelApi 1.1 ]

autoSave

Specifies if the workbook is in AutoSave mode.

readonly autoSave: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

bindings

Represents a collection of bindings that are part of the workbook.

readonly bindings: Excel.BindingCollection;

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

calculationEngineVersion

Returns a number about the version of Excel Calculation Engine.

readonly calculationEngineVersion: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.9 ]

chartDataPointTrack

True if all charts in the workbook are tracking the actual data points to which they are attached. False if the charts track the index of the data points.

chartDataPointTrack: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

comments

Represents a collection of comments associated with the workbook.

readonly comments: Excel.CommentCollection;

Property Value

Remarks

[ API set: ExcelApi 1.10 ]

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

customXmlParts

Represents the collection of custom XML parts contained by this workbook.

readonly customXmlParts: Excel.CustomXmlPartCollection;

Property Value

Remarks

[ API set: ExcelApi 1.5 ]

dataConnections

Represents all data connections in the workbook.

readonly dataConnections: Excel.DataConnectionCollection;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

functions

Represents a collection of worksheet functions that can be used for computation.

readonly functions: Excel.Functions;

Property Value

Remarks

[ API set: ExcelApi 1.2 ]

isDirty

Specifies if changes have been made since the workbook was last saved. You can set this property to true if you want to close a modified workbook without either saving it or being prompted to save it.

isDirty: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

name

Gets the workbook name.

readonly name: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.7 ]

names

Represents a collection of workbook-scoped named items (named ranges and constants).

readonly names: Excel.NamedItemCollection;

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

pivotTables

Represents a collection of PivotTables associated with the workbook.

readonly pivotTables: Excel.PivotTableCollection;

Property Value

Remarks

[ API set: ExcelApi 1.3 ]

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}`);
  });
});

pivotTableStyles

Represents a collection of PivotTableStyles associated with the workbook.

readonly pivotTableStyles: Excel.PivotTableStyleCollection;

Property Value

Remarks

[ API set: ExcelApi 1.10 ]

previouslySaved

Specifies if the workbook has ever been saved locally or online.

readonly previouslySaved: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

properties

Gets the workbook properties.

readonly properties: Excel.DocumentProperties;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/26-document/properties.yaml

await Excel.run(async (context) => {
    let titleValue = "Excel document properties API";
    let subjectValue = "Set and get document properties";
    let keywordsValue = "Set and get operations";
    let commentsValue = "This is an Excel document properties API code sample";
    let categoryValue = "Office Add-ins";
    let managerValue = "John";
    let companyValue = "Microsoft";

    let docProperties = context.workbook.properties;

    // Set the writeable document properties.
    docProperties.title = titleValue;
    docProperties.subject = subjectValue;
    docProperties.keywords = keywordsValue;
    docProperties.comments = commentsValue;
    docProperties.category = categoryValue;
    docProperties.manager = managerValue;
    docProperties.company = companyValue;

    await context.sync();

    console.log("Set the following document properties: title, subject, keywords, comments, category, manager, company.");
});

protection

Returns the protection object for a workbook.

readonly protection: Excel.WorkbookProtection;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

queries

Returns a collection of Power Query queries that are part of the workbook.

readonly queries: Excel.QueryCollection;

Property Value

Remarks

[ API set: ExcelApi 1.14 ]

readOnly

Returns true if the workbook is open in read-only mode.

readonly readOnly: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

settings

Represents a collection of settings associated with the workbook.

readonly settings: Excel.SettingCollection;

Property Value

Remarks

[ API set: ExcelApi 1.4 ]

slicers

Represents a collection of slicers associated with the workbook.

readonly slicers: Excel.SlicerCollection;

Property Value

Remarks

[ API set: ExcelApi 1.10 ]

slicerStyles

Represents a collection of SlicerStyles associated with the workbook.

readonly slicerStyles: Excel.SlicerStyleCollection;

Property Value

Remarks

[ API set: ExcelApi 1.10 ]

styles

Represents a collection of styles associated with the workbook.

readonly styles: Excel.StyleCollection;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml

await Excel.run(async (context) => {
    let styles = context.workbook.styles;

    // Add a new style to the style collection.
    // Styles is in the Home tab ribbon.
    styles.add("Diagonal Orientation Style");
          
    let newStyle = styles.getItem("Diagonal Orientation Style");
    
    // The "Diagonal Orientation Style" properties.
    newStyle.textOrientation = 38;
    newStyle.autoIndent = true;
    newStyle.includeProtection = true;
    newStyle.shrinkToFit = true;
    newStyle.locked = false;
    
    await context.sync();

    console.log("Successfully added a new style with diagonal orientation to the Home tab ribbon.");
});

tables

Represents a collection of tables associated with the workbook.

readonly tables: Excel.TableCollection;

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

tableStyles

Represents a collection of TableStyles associated with the workbook.

readonly tableStyles: Excel.TableStyleCollection;

Property Value

Remarks

[ API set: ExcelApi 1.10 ]

timelineStyles

Represents a collection of TimelineStyles associated with the workbook.

readonly timelineStyles: Excel.TimelineStyleCollection;

Property Value

Remarks

[ API set: ExcelApi 1.10 ]

usePrecisionAsDisplayed

True if calculations in this workbook will be done using only the precision of the numbers as they're displayed. Data will permanently lose accuracy when switching this property from false to true.

usePrecisionAsDisplayed: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

worksheets

Represents a collection of worksheets associated with the workbook.

readonly worksheets: Excel.WorksheetCollection;

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

Method Details

close(closeBehavior)

Close current workbook.

close(closeBehavior?: Excel.CloseBehavior): void;

Parameters

closeBehavior
Excel.CloseBehavior

workbook close behavior.

Returns

void

Remarks

[ API set: ExcelApi 1.11 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-save-and-close.yaml

await Excel.run(async (context) => {
    context.workbook.close(Excel.CloseBehavior.save);
});

close(closeBehaviorString)

Close current workbook.

close(closeBehaviorString?: "Save" | "SkipSave"): void;

Parameters

closeBehaviorString

"Save" | "SkipSave"

workbook close behavior.

Returns

void

Remarks

[ API set: ExcelApi 1.11 ]

getActiveCell()

Gets the currently active cell from the workbook.

getActiveCell(): Excel.Range;

Returns

Remarks

[ API set: ExcelApi 1.7 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-get-active-cell.yaml

await Excel.run(async (context) => {

    let myWorkbook = context.workbook;
    let activeCell = myWorkbook.getActiveCell();
    activeCell.load("address");

    await context.sync();
    
    console.log("The active cell is " + activeCell.address);
});

getActiveChart()

Gets the currently active chart in the workbook. If there is no active chart, an ItemNotFound exception is thrown.

getActiveChart(): Excel.Chart;

Returns

Remarks

[ API set: ExcelApi 1.9 ]

getActiveChartOrNullObject()

Gets the currently active chart in the workbook. If there is no active chart, then this method returns an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.

getActiveChartOrNullObject(): Excel.Chart;

Returns

Remarks

[ API set: ExcelApi 1.9 ]

getActiveSlicer()

Gets the currently active slicer in the workbook. If there is no active slicer, an ItemNotFound exception is thrown.

getActiveSlicer(): Excel.Slicer;

Returns

Remarks

[ API set: ExcelApi 1.10 ]

getActiveSlicerOrNullObject()

Gets the currently active slicer in the workbook. If there is no active slicer, then this method returns an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.

getActiveSlicerOrNullObject(): Excel.Slicer;

Returns

Remarks

[ API set: ExcelApi 1.10 ]

getIsActiveCollabSession()

Returns true if the workbook is being edited by multiple users (through co-authoring). Please be aware there might be some delay between when the workbook status changes and when the changes are reflected on the result of the method.

getIsActiveCollabSession(): OfficeExtension.ClientResult<boolean>;

Returns

Remarks

[ API set: ExcelApi 1.9 ]

getLinkedEntityCellValue(linkedEntityCellValueId)

Returns a LinkedEntityCellValue based on the provided LinkedEntityId.

getLinkedEntityCellValue(linkedEntityCellValueId: LinkedEntityId): OfficeExtension.ClientResult<LinkedEntityCellValue>;

Parameters

linkedEntityCellValueId
Excel.LinkedEntityId

An identifier that specifies an individual LinkedEntityCellValue.

Returns

Remarks

[ API set: ExcelApi 1.16 ]

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

[ API set: ExcelApi 1.1 ]

Examples

await Excel.run(async (context) => { 
    const selectedRange = context.workbook.getSelectedRange();
    selectedRange.load('address');
    await context.sync();
    console.log(selectedRange.address);
});

getSelectedRanges()

Gets the currently selected one or more ranges from the workbook. Unlike getSelectedRange(), this method returns a RangeAreas object that represents all the selected ranges.

getSelectedRanges(): Excel.RangeAreas;

Returns

Remarks

[ API set: ExcelApi 1.9 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-areas.yaml

await Excel.run(async (context) => {

    const selectedRanges = context.workbook.getSelectedRanges();
    selectedRanges.format.fill.color = "lightblue";

    await context.sync();
})

insertWorksheetsFromBase64(base64File, options)

Inserts the specified worksheets from a source workbook into the current workbook.

Note*: This API is currently only supported for Office on Windows, Mac, and the web.

insertWorksheetsFromBase64(base64File: string, options?: Excel.InsertWorksheetOptions): OfficeExtension.ClientResult<string[]>;

Parameters

base64File

string

Required. The Base64-encoded string representing the source workbook file.

options
Excel.InsertWorksheetOptions

Optional. The options that define which worksheets to insert and where in the workbook the new worksheets will be inserted. By default, all the worksheets from the source workbook are inserted at the end of the current workbook.

Returns

An array of IDs corresponding to each newly inserted worksheet.

Remarks

[ API set: ExcelApi 1.13 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-insert-external-worksheets.yaml

// Retrieve the file and set up an HTML FileReader element. 
const myFile = <HTMLInputElement>document.getElementById("file");
const reader = new FileReader();

reader.onload = (event) => {
    // Remove the metadata before the Base64-encoded string.
    const startIndex = reader.result.toString().indexOf("base64,");
    externalWorkbook = reader.result.toString().substr(startIndex + 7);
};

// Read the file as a data URL so that we can parse the Base64-encoded string.
reader.readAsDataURL(myFile.files[0]);

...

await Excel.run(async (context) => {
    // Retrieve the source workbook.
    const workbook = context.workbook;
    
    // Set up the insert options.
    const options = {
        sheetNamesToInsert: [], // Insert all the worksheets from the source workbook.
        positionType: Excel.WorksheetPositionType.after, // Insert after the `relativeTo` sheet.
        relativeTo: "Sheet1" // The sheet relative to which the other worksheets will be inserted. Used with `positionType`.
    };
    
    // Insert the new worksheets.
    workbook.insertWorksheetsFromBase64(externalWorkbook, options);
    await context.sync();
});

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

options
Excel.Interfaces.WorkbookLoadOptions

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

save(saveBehavior)

Save current workbook.

save(saveBehavior?: Excel.SaveBehavior): void;

Parameters

saveBehavior
Excel.SaveBehavior

The save behavior must be "Save" or "Prompt". Default value is "Save".

Returns

void

Remarks

[ API set: ExcelApi 1.11 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-save-and-close.yaml

await Excel.run(async (context) => {
    context.workbook.save(Excel.SaveBehavior.save);
});

save(saveBehaviorString)

Save current workbook.

save(saveBehaviorString?: "Save" | "Prompt"): void;

Parameters

saveBehaviorString

"Save" | "Prompt"

The save behavior must be "Save" or "Prompt". Default value is "Save".

Returns

void

Remarks

[ API set: ExcelApi 1.11 ]

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

onActivated

Occurs when the workbook is activated. Note: This event will not fire when the workbook is opened.

readonly onActivated: OfficeExtension.EventHandlers<Excel.WorkbookActivatedEventArgs>;

Event Type

Remarks

[ API set: ExcelApi 1.13 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-activated.yaml

async function workbookActivated(event: Excel.WorkbookActivatedEventArgs) {
  await Excel.run(async (context) => {
    // Callback function for when the workbook is activated.
    console.log("The workbook was activated.");
  });
}

...

await Excel.run(async (context) => {
  const workbook = context.workbook;

  // Register the workbook activated event handler.
  workbook.onActivated.add(workbookActivated);

  await context.sync();
  console.log("Added event handler for workbook activated.");
});

onAutoSaveSettingChanged

Occurs when the AutoSave setting is changed on the workbook.

readonly onAutoSaveSettingChanged: OfficeExtension.EventHandlers<Excel.WorkbookAutoSaveSettingChangedEventArgs>;

Event Type

Remarks

[ API set: ExcelApi 1.9 ]

onSelectionChanged

Occurs when the selection in the document is changed.

readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.SelectionChangedEventArgs>;

Event Type

Remarks

[ API set: ExcelApi 1.2 ]