Edit

Share via

Excel.WorkbookCreated class

Package:
excel

The WorkbookCreated object is the top level object created by Application.CreateWorkbook. A WorkbookCreated object is a special Workbook object.

Extends
OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.8 ]

Properties

context

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

Methods

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.
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.WorkbookCreated object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.WorkbookCreatedData) that contains shallow copies of any loaded child properties from the original object.

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

Excel.RequestContext

Method Details

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

Parameters

propertyNames

string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

Excel.WorkbookCreated

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

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

Excel.WorkbookCreated

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.WorkbookCreated object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.WorkbookCreatedData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.WorkbookCreatedData;

Returns

Excel.Interfaces.WorkbookCreatedData