-
Notifications
You must be signed in to change notification settings - Fork 63
/
excel.settingcollection.yml
280 lines (251 loc) · 10.2 KB
/
excel.settingcollection.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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
### YamlMime:TSType
name: Excel.SettingCollection
uid: 'excel!Excel.SettingCollection:class'
package: excel!
fullName: Excel.SettingCollection
summary: >-
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](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
- name: context
uid: 'excel!Excel.SettingCollection#context:member'
package: excel!
fullName: context
summary: >-
The request context associated with the object. This connects the add-in's process to the Office host
application's process.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'context: RequestContext;'
return:
type: '<xref uid="excel!Excel.RequestContext:class" />'
- name: items
uid: 'excel!Excel.SettingCollection#items:member'
package: excel!
fullName: items
summary: Gets the loaded child items in this collection.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'readonly items: Excel.Setting[];'
return:
type: '<xref uid="excel!Excel.Setting:class" />[]'
methods:
- name: 'add(key, value)'
uid: 'excel!Excel.SettingCollection#add:member(1)'
package: excel!
fullName: 'add(key, value)'
summary: Sets or adds the specified setting to the workbook.
remarks: >-
\[ [API set: ExcelApi 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-and-worksheet-collection.yaml
await Excel.run(async (context) => {
const settings = context.workbook.settings;
settings.onSettingsChanged.add(onChangedSetting);
await context.sync();
console.log("Settings changed handler registered.");
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'add(key: string, value: string | number | boolean | Date | any[] | any): Excel.Setting;'
parameters:
- id: key
description: The key of the new setting.
type: string
- id: value
description: The value for the new setting.
type: 'string | number | boolean | Date | any[] | any'
return:
type: '<xref uid="excel!Excel.Setting:class" />'
description: ''
- name: getCount()
uid: 'excel!Excel.SettingCollection#getCount:member(1)'
package: excel!
fullName: getCount()
summary: Gets the number of settings in the collection.
remarks: '\[ [API set: ExcelApi 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'getCount(): OfficeExtension.ClientResult<number>;'
return:
type: '<xref uid="office!OfficeExtension.ClientResult:class" /><number>'
description: ''
- name: getItem(key)
uid: 'excel!Excel.SettingCollection#getItem:member(1)'
package: excel!
fullName: getItem(key)
summary: Gets a setting entry via the key.
remarks: '\[ [API set: ExcelApi 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'getItem(key: string): Excel.Setting;'
parameters:
- id: key
description: Key of the setting.
type: string
return:
type: '<xref uid="excel!Excel.Setting:class" />'
description: ''
- name: getItemOrNullObject(key)
uid: 'excel!Excel.SettingCollection#getItemOrNullObject:member(1)'
package: excel!
fullName: getItemOrNullObject(key)
summary: >-
Gets a setting entry via the key. If the setting does not exist, then this method returns an object with its
`isNullObject` property set to `true`<!-- -->. For further information, see [*OrNullObject methods and
properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties)<!--
-->.
remarks: >-
\[ [API set: ExcelApi 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/create-get-change-delete-settings.yaml
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();
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'getItemOrNullObject(key: string): Excel.Setting;'
parameters:
- id: key
description: The key of the setting.
type: string
return:
type: '<xref uid="excel!Excel.Setting:class" />'
description: ''
- name: load(options)
uid: 'excel!Excel.SettingCollection#load:member(1)'
package: excel!
fullName: load(options)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
load(options?: Excel.Interfaces.SettingCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions):
Excel.SettingCollection;
parameters:
- id: options
description: Provides options for which properties of the object to load.
type: >-
<xref uid="excel!Excel.Interfaces.SettingCollectionLoadOptions:interface" /> & <xref
uid="excel!Excel.Interfaces.CollectionLoadOptions:interface" />
return:
type: '<xref uid="excel!Excel.SettingCollection:class" />'
description: ''
- name: load(propertyNames)
uid: 'excel!Excel.SettingCollection#load:member(2)'
package: excel!
fullName: load(propertyNames)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'load(propertyNames?: string | string[]): Excel.SettingCollection;'
parameters:
- id: propertyNames
description: A comma-delimited string or an array of strings that specify the properties to load.
type: 'string | string[]'
return:
type: '<xref uid="excel!Excel.SettingCollection:class" />'
description: ''
- name: load(propertyNamesAndPaths)
uid: 'excel!Excel.SettingCollection#load:member(3)'
package: excel!
fullName: load(propertyNamesAndPaths)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.SettingCollection;'
parameters:
- id: propertyNamesAndPaths
description: >-
`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.
type: '<xref uid="office!OfficeExtension.LoadOption:interface" />'
return:
type: '<xref uid="excel!Excel.SettingCollection:class" />'
description: ''
- name: toJSON()
uid: 'excel!Excel.SettingCollection#toJSON:member(1)'
package: excel!
fullName: toJSON()
summary: >-
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.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): Excel.Interfaces.SettingCollectionData;'
return:
type: '<xref uid="excel!Excel.Interfaces.SettingCollectionData:interface" />'
description: ''
events:
- name: onSettingsChanged
uid: 'excel!Excel.SettingCollection#onSettingsChanged:member'
package: excel!
fullName: onSettingsChanged
summary: Occurs when the settings in the document are changed.
remarks: >-
\[ [API set: ExcelApi 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-and-worksheet-collection.yaml
await Excel.run(async (context) => {
const settings = context.workbook.settings;
settings.onSettingsChanged.add(onChangedSetting);
await context.sync();
console.log("Settings changed handler registered.");
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'readonly onSettingsChanged: OfficeExtension.EventHandlers<Excel.SettingsChangedEventArgs>;'
return:
type: >-
<xref uid="office!OfficeExtension.EventHandlers:class" /><<xref
uid="excel!Excel.SettingsChangedEventArgs:interface" />>
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'