-
Notifications
You must be signed in to change notification settings - Fork 62
/
excel.interfaces.settingloadoptions.yml
53 lines (53 loc) · 2.02 KB
/
excel.interfaces.settingloadoptions.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
### YamlMime:TSType
name: Excel.Interfaces.SettingLoadOptions
uid: 'excel!Excel.Interfaces.SettingLoadOptions:interface'
package: excel!
fullName: Excel.Interfaces.SettingLoadOptions
summary: >-
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](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
- name: $all
uid: 'excel!Excel.Interfaces.SettingLoadOptions#$all:member'
package: excel!
fullName: $all
summary: >-
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`<!-- -->) but not the
navigational properties (e.g.: `Range.format.fill.color`<!-- -->).
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: '$all?: boolean;'
return:
type: boolean
- name: key
uid: 'excel!Excel.Interfaces.SettingLoadOptions#key:member'
package: excel!
fullName: key
summary: The key that represents the ID of the setting.
remarks: '\[ [API set: ExcelApi 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'key?: boolean;'
return:
type: boolean
- name: value
uid: 'excel!Excel.Interfaces.SettingLoadOptions#value:member'
package: excel!
fullName: value
summary: Represents the value stored for this setting.
remarks: '\[ [API set: ExcelApi 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'value?: boolean;'
return:
type: boolean