-
Notifications
You must be signed in to change notification settings - Fork 61
/
excel.interfaces.nameditemloadoptions.yml
193 lines (193 loc) · 8.17 KB
/
excel.interfaces.nameditemloadoptions.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
### YamlMime:TSType
name: Excel.Interfaces.NamedItemLoadOptions
uid: 'excel!Excel.Interfaces.NamedItemLoadOptions:interface'
package: excel!
fullName: Excel.Interfaces.NamedItemLoadOptions
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) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
- name: $all
uid: 'excel!Excel.Interfaces.NamedItemLoadOptions#$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: arrayValues
uid: 'excel!Excel.Interfaces.NamedItemLoadOptions#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: 'arrayValues?: Excel.Interfaces.NamedItemArrayValuesLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.NamedItemArrayValuesLoadOptions:interface" />'
- name: comment
uid: 'excel!Excel.Interfaces.NamedItemLoadOptions#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?: boolean;'
return:
type: boolean
- name: formula
uid: 'excel!Excel.Interfaces.NamedItemLoadOptions#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) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'formula?: boolean;'
return:
type: boolean
- name: name
uid: 'excel!Excel.Interfaces.NamedItemLoadOptions#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: 'name?: boolean;'
return:
type: boolean
- name: scope
uid: 'excel!Excel.Interfaces.NamedItemLoadOptions#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: 'scope?: boolean;'
return:
type: boolean
- name: type
uid: 'excel!Excel.Interfaces.NamedItemLoadOptions#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: 'type?: boolean;'
return:
type: boolean
- name: value
uid: 'excel!Excel.Interfaces.NamedItemLoadOptions#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: 'value?: boolean;'
return:
type: boolean
- name: valueAsJson
uid: 'excel!Excel.Interfaces.NamedItemLoadOptions#valueAsJson:member'
package: excel!
fullName: valueAsJson
summary: >-
A JSON representation of the values in this named item. Unlike `NamedItem.value`<!-- -->, `NamedItem.valueAsJson`
supports all data types which can be in a cell. Examples include formatted number values and web images, in
addition to the standard boolean, number, and string values. Data returned from this API always aligns with the
en-US locale. To retrieve data in the user's display locale, use `NamedItem.valueAsJsonLocal`<!-- -->.
remarks: '\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'valueAsJson?: boolean;'
return:
type: boolean
- name: valueAsJsonLocal
uid: 'excel!Excel.Interfaces.NamedItemLoadOptions#valueAsJsonLocal:member'
package: excel!
fullName: valueAsJsonLocal
summary: >-
A JSON representation of the values in this named item. Unlike `NamedItem.value`<!-- -->,
`NamedItem.valueAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number
values and web images, in addition to the standard boolean, number, and string values. Data returned from this API
always aligns with the user's display locale. To retrieve data independent of locale, use
`NamedItem.valueAsJson`<!-- -->.
remarks: '\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'valueAsJsonLocal?: boolean;'
return:
type: boolean
- name: visible
uid: 'excel!Excel.Interfaces.NamedItemLoadOptions#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.Interfaces.NamedItemLoadOptions#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: 'worksheet?: Excel.Interfaces.WorksheetLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.WorksheetLoadOptions:interface" />'
- name: worksheetOrNullObject
uid: 'excel!Excel.Interfaces.NamedItemLoadOptions#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: 'worksheetOrNullObject?: Excel.Interfaces.WorksheetLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.WorksheetLoadOptions:interface" />'