Excel.SettingCollection class

Represents a collection of key-value pair setting objects that are part of the workbook. The scope is limited to per file and add-in (task-pane or content) combination.

[ API set: ExcelApi 1.4 ]

Extends
OfficeExtension.ClientObject

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(key, value)

Sets or adds the specified setting to the workbook.

[ API set: ExcelApi 1.4 ]

getCount()

Gets the number of Settings in the collection.

[ API set: ExcelApi 1.4 ]

getItem(key)

Gets a Setting entry via the key.

[ API set: ExcelApi 1.4 ]

getItemOrNullObject(key)

Gets a Setting entry via the key. If the Setting does not exist, will return a null object.

[ API set: ExcelApi 1.4 ]

load(option)

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(option)
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.SettingCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.SettingCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

Events

onSettingsChanged

Occurs when the Settings in the document are changed.

[ API set: ExcelApi 1.4 ]

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.Setting[];

Property Value

Method Details

add(key, value)

Sets or adds the specified setting to the workbook.

[ API set: ExcelApi 1.4 ]

add(key: string, value: string | number | boolean | Date | Array<any> | any): Excel.Setting;

Parameters

key
string

The Key of the new setting.

value
string | number | boolean | Date | Array<any> | any

The Value for the new setting.

Returns

Examples

await Excel.run(async (context) => {
    const settings = context.workbook.settings; 
    settings.onSettingsChanged.add(onChangedSetting);

    await context.sync();
    console.log("Settings changed handler registered.");
});

getCount()

Gets the number of Settings in the collection.

[ API set: ExcelApi 1.4 ]

getCount(): OfficeExtension.ClientResult<number>;

Returns

OfficeExtension.ClientResult<number>

getItem(key)

Gets a Setting entry via the key.

[ API set: ExcelApi 1.4 ]

getItem(key: string): Excel.Setting;

Parameters

key
string

Key of the setting.

Returns

getItemOrNullObject(key)

Gets a Setting entry via the key. If the Setting does not exist, will return a null object.

[ API set: ExcelApi 1.4 ]

getItemOrNullObject(key: string): Excel.Setting;

Parameters

key
string

The key of the setting.

Returns

Examples

await Excel.run(async (context) => {
    const settings = context.workbook.settings;
    let needsReview = settings.getItem("NeedsReview");
    needsReview.delete();
    needsReview = settings.getItemOrNullObject("NeedsReview");

    await context.sync();

    if (needsReview.isNullObject) {
        console.log("The setting has been deleted");
    } else {
        console.log("The setting was not deleted");
    }

    await context.sync();
});

load(option)

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

load(option?: Excel.Interfaces.SettingCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SettingCollection;

Parameters

Returns

Remarks

In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.SettingCollection - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.SettingCollection - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.SettingCollection - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items.

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

Parameters

propertyNames
string | string[]

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

Returns

load(option)

load(option?: OfficeExtension.LoadOption): Excel.SettingCollection;

Parameters

option
OfficeExtension.LoadOption

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 is passed to it.) Whereas the original Excel.SettingCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.SettingCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

toJSON(): Excel.Interfaces.SettingCollectionData;

Returns

Event Details

onSettingsChanged

Occurs when the Settings in the document are changed.

[ API set: ExcelApi 1.4 ]

readonly onSettingsChanged: OfficeExtension.EventHandlers<Excel.SettingsChangedEventArgs>;

Returns

OfficeExtension.EventHandlers<Excel.SettingsChangedEventArgs>

Examples

await Excel.run(async (context) => {
    const settings = context.workbook.settings; 
    settings.onSettingsChanged.add(onChangedSetting);

    await context.sync();
    console.log("Settings changed handler registered.");
});