Edit

Share via

Excel.Interfaces.SettingCollectionLoadOptions interface

  • Reference
Package:
excel

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.

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

For EACH ITEM in the collection: The key that represents the ID of the setting.
value

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: The key that represents the ID of the setting.

key?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.4 ]

value

For EACH ITEM in the collection: Represents the value stored for this setting.

value?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.4 ]