/
excel.interfaces.rangeloadoptions.yml
278 lines (278 loc) · 11.4 KB
/
excel.interfaces.rangeloadoptions.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
### YamlMime:TSType
name: Excel.Interfaces.RangeLoadOptions
uid: 'excel!Excel.Interfaces.RangeLoadOptions:interface'
package: excel!
fullName: Excel.Interfaces.RangeLoadOptions
summary: >-
Range represents a set of one or more contiguous cells such as a cell, a row, a column, or a block of cells. To learn
more about how ranges are used throughout the API, start with [Ranges in the Excel JavaScript
API](https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-core-concepts#ranges)<!-- -->.
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.RangeLoadOptions#$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: address
uid: 'excel!Excel.Interfaces.RangeLoadOptions#address:member'
package: excel!
fullName: address
summary: 'Specifies the range reference in A1-style. Address value contains the sheet reference (e.g., "Sheet1!A1:B4").'
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'address?: boolean;'
return:
type: boolean
- name: addressLocal
uid: 'excel!Excel.Interfaces.RangeLoadOptions#addressLocal:member'
package: excel!
fullName: addressLocal
summary: Represents the range reference for the specified range in the language of the user.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'addressLocal?: boolean;'
return:
type: boolean
- name: cellCount
uid: 'excel!Excel.Interfaces.RangeLoadOptions#cellCount:member'
package: excel!
fullName: cellCount
summary: >-
Specifies the number of cells in the range. This API will return -1 if the cell count exceeds 2^31-1
(2,147,483,647).
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'cellCount?: boolean;'
return:
type: boolean
- name: columnCount
uid: 'excel!Excel.Interfaces.RangeLoadOptions#columnCount:member'
package: excel!
fullName: columnCount
summary: Specifies the total number of columns in the range.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'columnCount?: boolean;'
return:
type: boolean
- name: columnHidden
uid: 'excel!Excel.Interfaces.RangeLoadOptions#columnHidden:member'
package: excel!
fullName: columnHidden
summary: >-
Represents if all columns in the current range are hidden. Value is `true` when all columns in a range are hidden.
Value is `false` when no columns in the range are hidden. Value is `null` when some columns in a range are hidden
and other columns in the same range are not hidden.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'columnHidden?: boolean;'
return:
type: boolean
- name: columnIndex
uid: 'excel!Excel.Interfaces.RangeLoadOptions#columnIndex:member'
package: excel!
fullName: columnIndex
summary: Specifies the column number of the first cell in the range. Zero-indexed.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'columnIndex?: boolean;'
return:
type: boolean
- name: format
uid: 'excel!Excel.Interfaces.RangeLoadOptions#format:member'
package: excel!
fullName: format
summary: 'Returns a format object, encapsulating the range''s font, fill, borders, alignment, and other properties.'
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'format?: Excel.Interfaces.RangeFormatLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.RangeFormatLoadOptions:interface" />'
- name: formulas
uid: 'excel!Excel.Interfaces.RangeLoadOptions#formulas:member'
package: excel!
fullName: formulas
summary: 'Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.'
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'formulas?: boolean;'
return:
type: boolean
- name: formulasLocal
uid: 'excel!Excel.Interfaces.RangeLoadOptions#formulasLocal:member'
package: excel!
fullName: formulasLocal
summary: >-
Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the
English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its value is
returned instead.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'formulasLocal?: boolean;'
return:
type: boolean
- name: formulasR1C1
uid: 'excel!Excel.Interfaces.RangeLoadOptions#formulasR1C1:member'
package: excel!
fullName: formulasR1C1
summary: 'Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead.'
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'formulasR1C1?: boolean;'
return:
type: boolean
- name: hidden
uid: 'excel!Excel.Interfaces.RangeLoadOptions#hidden:member'
package: excel!
fullName: hidden
summary: >-
Represents if all cells in the current range are hidden. Value is `true` when all cells in a range are hidden.
Value is `false` when no cells in the range are hidden. Value is `null` when some cells in a range are hidden and
other cells in the same range are not hidden.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'hidden?: boolean;'
return:
type: boolean
- name: numberFormat
uid: 'excel!Excel.Interfaces.RangeLoadOptions#numberFormat:member'
package: excel!
fullName: numberFormat
summary: >-
Represents Excel's number format code for the given range. For more information about Excel number formatting, see
[Number format
codes](https://support.microsoft.com/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68)<!-- -->.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'numberFormat?: boolean;'
return:
type: boolean
- name: rowCount
uid: 'excel!Excel.Interfaces.RangeLoadOptions#rowCount:member'
package: excel!
fullName: rowCount
summary: Returns the total number of rows in the range.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'rowCount?: boolean;'
return:
type: boolean
- name: rowHidden
uid: 'excel!Excel.Interfaces.RangeLoadOptions#rowHidden:member'
package: excel!
fullName: rowHidden
summary: >-
Represents if all rows in the current range are hidden. Value is `true` when all rows in a range are hidden. Value
is `false` when no rows in the range are hidden. Value is `null` when some rows in a range are hidden and other
rows in the same range are not hidden.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'rowHidden?: boolean;'
return:
type: boolean
- name: rowIndex
uid: 'excel!Excel.Interfaces.RangeLoadOptions#rowIndex:member'
package: excel!
fullName: rowIndex
summary: Returns the row number of the first cell in the range. Zero-indexed.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'rowIndex?: boolean;'
return:
type: boolean
- name: text
uid: 'excel!Excel.Interfaces.RangeLoadOptions#text:member'
package: excel!
fullName: text
summary: >-
Text values of the specified range. The text value will not depend on the cell width. The number sign (\#)
substitution that happens in the Excel UI will not affect the text value returned by the API.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'text?: boolean;'
return:
type: boolean
- name: values
uid: 'excel!Excel.Interfaces.RangeLoadOptions#values:member'
package: excel!
fullName: values
summary: >-
Represents the raw values of the specified range. The data returned could be a string, number, or boolean. Cells
that contain an error will return the error string. If the returned value starts with a plus ("+"), minus ("-"),
or equal sign ("="), Excel interprets this value as a formula.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'values?: boolean;'
return:
type: boolean
- name: valueTypes
uid: 'excel!Excel.Interfaces.RangeLoadOptions#valueTypes:member'
package: excel!
fullName: valueTypes
summary: Specifies the type of data in each cell.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'valueTypes?: boolean;'
return:
type: boolean
- name: worksheet
uid: 'excel!Excel.Interfaces.RangeLoadOptions#worksheet:member'
package: excel!
fullName: worksheet
summary: The worksheet containing the current range.
remarks: '\[ [API set: ExcelApi 1.1](/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" />'