-
Notifications
You must be signed in to change notification settings - Fork 63
/
excel.nameditem.yml
459 lines (419 loc) · 16.8 KB
/
excel.nameditem.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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
### YamlMime:TSType
name: Excel.NamedItem
uid: 'excel!Excel.NamedItem:class'
package: excel!
fullName: Excel.NamedItem
summary: >-
Represents a defined name for a range of cells or value. Names can be primitive named objects (as seen in the type
below), range object, or a reference to a range. This object can be used to obtain range object associated with names.
remarks: >-
\[ [API set: ExcelApi 1.1](/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/34-named-item/create-and-remove-named-item.yaml
await Excel.run(async (context) => {
// Log all the named items in the active worksheet.
const namedItems = context.workbook.worksheets.getActiveWorksheet().names.load();
await context.sync();
console.log("This worksheet contains " + namedItems.items.length + " named items.");
for (let i = 0; i < namedItems.items.length; i++) {
const namedItem : Excel.NamedItem = namedItems.items[i];
console.log(JSON.stringify(namedItem)) + "\n";
}
await context.sync();
});
```
isPreview: false
isDeprecated: false
type: class
properties:
- name: arrayValues
uid: 'excel!Excel.NamedItem#arrayValues:member'
package: excel!
fullName: arrayValues
summary: Returns an object containing values and types of the named item.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly arrayValues: Excel.NamedItemArrayValues;'
return:
type: '<xref uid="excel!Excel.NamedItemArrayValues:class" />'
- name: comment
uid: 'excel!Excel.NamedItem#comment:member'
package: excel!
fullName: comment
summary: Specifies the comment associated with this name.
remarks: '\[ [API set: ExcelApi 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'comment: string;'
return:
type: string
- name: context
uid: 'excel!Excel.NamedItem#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: formula
uid: 'excel!Excel.NamedItem#formula:member'
package: excel!
fullName: formula
summary: The formula of the named item. Formulas always start with an equal sign ("=").
remarks: >-
\[ [API set: ExcelApi 1.7](/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/34-named-item/update-named-item.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
// Get the named item
const myNamedItem = sheet.names.getItemOrNullObject("MyRange");
myNamedItem.load("name, formula");
await context.sync();
if (myNamedItem.isNullObject) {
console.log(`There is no named item. Create it with "Add named item for a range" first.`);
} else {
// Update named item to point to the second range
myNamedItem.formula = "=Sample!$B$10:$D$14";
sheet.getRange("B10:D14").select();
await context.sync();
console.log(`Just updated the named item "${myNamedItem.name}" -- it's now located here: ${myNamedItem.formula}`);
}
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'formula: any;'
return:
type: any
- name: name
uid: 'excel!Excel.NamedItem#name:member'
package: excel!
fullName: name
summary: The name of the object.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly name: string;'
return:
type: string
- name: scope
uid: 'excel!Excel.NamedItem#scope:member'
package: excel!
fullName: scope
summary: >-
Specifies if the name is scoped to the workbook or to a specific worksheet. Possible values are: Worksheet,
Workbook.
remarks: '\[ [API set: ExcelApi 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly scope: Excel.NamedItemScope | "Worksheet" | "Workbook";'
return:
type: '<xref uid="excel!Excel.NamedItemScope:enum" /> | "Worksheet" | "Workbook"'
- name: type
uid: 'excel!Excel.NamedItem#type:member'
package: excel!
fullName: type
summary: Specifies the type of the value returned by the name's formula. See `Excel.NamedItemType` for details.
remarks: >-
\[ [API set: ExcelApi 1.1 for String,Integer,Double,Boolean,Range,Error; 1.7 for
Array](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
isPreview: false
isDeprecated: false
syntax:
content: 'readonly type: Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array";'
return:
type: >-
<xref uid="excel!Excel.NamedItemType:enum" /> | "String" | "Integer" | "Double" | "Boolean" | "Range" |
"Error" | "Array"
- name: value
uid: 'excel!Excel.NamedItem#value:member'
package: excel!
fullName: value
summary: >-
Represents the value computed by the name's formula. For a named range, it will return the range address. This API
returns the \#VALUE! error in the Excel UI if it refers to a user-defined function.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly value: any;'
return:
type: any
- name: visible
uid: 'excel!Excel.NamedItem#visible:member'
package: excel!
fullName: visible
summary: Specifies if the object is visible.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'visible: boolean;'
return:
type: boolean
- name: worksheet
uid: 'excel!Excel.NamedItem#worksheet:member'
package: excel!
fullName: worksheet
summary: >-
Returns the worksheet on which the named item is scoped to. Throws an error if the item is scoped to the workbook
instead.
remarks: '\[ [API set: ExcelApi 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly worksheet: Excel.Worksheet;'
return:
type: '<xref uid="excel!Excel.Worksheet:class" />'
- name: worksheetOrNullObject
uid: 'excel!Excel.NamedItem#worksheetOrNullObject:member'
package: excel!
fullName: worksheetOrNullObject
summary: >-
Returns the worksheet to which the named item is scoped. If the item is scoped to the workbook instead, 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) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly worksheetOrNullObject: Excel.Worksheet;'
return:
type: '<xref uid="excel!Excel.Worksheet:class" />'
methods:
- name: delete()
uid: 'excel!Excel.NamedItem#delete:member(1)'
package: excel!
fullName: delete()
summary: Deletes the given name.
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/34-named-item/create-and-remove-named-item.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const totalName = sheet.names.getItemOrNullObject("TotalAmount");
totalName.load();
await context.sync();
if (totalName.value) {
totalName.delete();
// Replace the named item (TotalAmount) with the actual formula for TotalAmount to avoid displaying #NAME in the cell.
sheet.getRange("D11").values = [["=SUM(ExpensesTable[AMOUNT])"]];
} else {
console.log("No named item created for the formula.");
}
await context.sync();
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'delete(): void;'
return:
type: void
description: ''
- name: getRange()
uid: 'excel!Excel.NamedItem#getRange:member(1)'
package: excel!
fullName: getRange()
summary: >-
Returns the range object that is associated with the name. Throws an error if the named item's type is not a
range.
remarks: |-
\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Returns the Range object that is associated with the name.
// Returns `null` if the name is not of type Range.
// Note: This API currently supports only the Workbook scoped items.
await Excel.run(async (context) => {
const names = context.workbook.names;
const range = names.getItem('MyRange').getRange();
range.load('address');
await context.sync();
console.log(range.address);
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'getRange(): Excel.Range;'
return:
type: '<xref uid="excel!Excel.Range:class" />'
description: ''
- name: getRangeOrNullObject()
uid: 'excel!Excel.NamedItem#getRangeOrNullObject:member(1)'
package: excel!
fullName: getRangeOrNullObject()
summary: >-
Returns the range object that is associated with the name. If the named item's type is not a range, 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) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'getRangeOrNullObject(): Excel.Range;'
return:
type: '<xref uid="excel!Excel.Range:class" />'
description: ''
- name: load(options)
uid: 'excel!Excel.NamedItem#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.NamedItemLoadOptions): Excel.NamedItem;'
parameters:
- id: options
description: Provides options for which properties of the object to load.
type: '<xref uid="excel!Excel.Interfaces.NamedItemLoadOptions:interface" />'
return:
type: '<xref uid="excel!Excel.NamedItem:class" />'
description: ''
- name: load(propertyNames)
uid: 'excel!Excel.NamedItem#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.NamedItem;'
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.NamedItem:class" />'
description: |-
#### Examples
```TypeScript
await Excel.run(async (context) => {
const names = context.workbook.names;
const namedItem = names.getItem('MyRange');
namedItem.load('type');
await context.sync();
console.log(namedItem.type);
});
```
- name: load(propertyNamesAndPaths)
uid: 'excel!Excel.NamedItem#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?: {
select?: string;
expand?: string;
}): Excel.NamedItem;
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: |-
{
select?: string;
expand?: string;
}
return:
type: '<xref uid="excel!Excel.NamedItem:class" />'
description: ''
- name: 'set(properties, options)'
uid: 'excel!Excel.NamedItem#set:member(1)'
package: excel!
fullName: 'set(properties, options)'
summary: >-
Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate
properties, or another API object of the same type.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'set(properties: Interfaces.NamedItemUpdateData, options?: OfficeExtension.UpdateOptions): void;'
parameters:
- id: properties
description: >-
A JavaScript object with properties that are structured isomorphically to the properties of the object on
which the method is called.
type: '<xref uid="excel!Excel.Interfaces.NamedItemUpdateData:interface" />'
- id: options
description: Provides an option to suppress errors if the properties object tries to set any read-only properties.
type: '<xref uid="office!OfficeExtension.UpdateOptions:interface" />'
return:
type: void
description: ''
- name: set(properties)
uid: 'excel!Excel.NamedItem#set:member(2)'
package: excel!
fullName: set(properties)
summary: 'Sets multiple properties on the object at the same time, based on an existing loaded object.'
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'set(properties: Excel.NamedItem): void;'
parameters:
- id: properties
description: ''
type: '<xref uid="excel!Excel.NamedItem:class" />'
return:
type: void
description: ''
- name: toJSON()
uid: 'excel!Excel.NamedItem#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.NamedItem object is an API object, the `toJSON` method returns a plain
JavaScript object (typed as `Excel.Interfaces.NamedItemData`<!-- -->) that contains shallow copies of any loaded
child properties from the original object.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): Excel.Interfaces.NamedItemData;'
return:
type: '<xref uid="excel!Excel.Interfaces.NamedItemData:interface" />'
description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'