Edit

Share via

Excel.Interfaces.SettingLoadOptions interface

Package:
excel

Setting represents a key-value pair of a setting persisted to the document (per file, per add-in). These custom key-value pair can be used to store state or lifecycle information needed by the content or task-pane add-in. Note that settings are persisted in the document and hence it is not a place to store any sensitive or protected information such as user information and password.

Remarks

[ API set: ExcelApi 1.4 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
key

The key that represents the ID of the setting.
value

Represents the value stored for this setting.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

key

The key that represents the ID of the setting.

key?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.4 ]

value

Represents the value stored for this setting.

value?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.4 ]