-
Notifications
You must be signed in to change notification settings - Fork 63
/
excel.interfaces.worksheetloadoptions.yml
236 lines (236 loc) · 9.7 KB
/
excel.interfaces.worksheetloadoptions.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
### YamlMime:TSType
name: Excel.Interfaces.WorksheetLoadOptions
uid: 'excel!Excel.Interfaces.WorksheetLoadOptions:interface'
package: excel!
fullName: Excel.Interfaces.WorksheetLoadOptions
summary: >-
An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc. To learn more about the worksheet
object model, read [Work with worksheets using the Excel JavaScript
API](https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-worksheets)<!-- -->.
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.WorksheetLoadOptions#$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: autoFilter
uid: 'excel!Excel.Interfaces.WorksheetLoadOptions#autoFilter:member'
package: excel!
fullName: autoFilter
summary: Represents the `AutoFilter` object of the worksheet.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'autoFilter?: Excel.Interfaces.AutoFilterLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.AutoFilterLoadOptions:interface" />'
- name: charts
uid: 'excel!Excel.Interfaces.WorksheetLoadOptions#charts:member'
package: excel!
fullName: charts
summary: Returns a collection of charts that are part of the worksheet.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'charts?: Excel.Interfaces.ChartCollectionLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.ChartCollectionLoadOptions:interface" />'
- name: enableCalculation
uid: 'excel!Excel.Interfaces.WorksheetLoadOptions#enableCalculation:member'
package: excel!
fullName: enableCalculation
summary: >-
Determines if Excel should recalculate the worksheet when necessary. True if Excel recalculates the worksheet when
necessary. False if Excel doesn't recalculate the sheet.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'enableCalculation?: boolean;'
return:
type: boolean
- name: id
uid: 'excel!Excel.Interfaces.WorksheetLoadOptions#id:member'
package: excel!
fullName: id
summary: >-
Returns a value that uniquely identifies the worksheet in a given workbook. The value of the identifier remains
the same even when the worksheet is renamed or moved.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'id?: boolean;'
return:
type: boolean
- name: name
uid: 'excel!Excel.Interfaces.WorksheetLoadOptions#name:member'
package: excel!
fullName: name
summary: The display name of the worksheet. The name must be fewer than 32 characters.
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: pageLayout
uid: 'excel!Excel.Interfaces.WorksheetLoadOptions#pageLayout:member'
package: excel!
fullName: pageLayout
summary: Gets the `PageLayout` object of the worksheet.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'pageLayout?: Excel.Interfaces.PageLayoutLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.PageLayoutLoadOptions:interface" />'
- name: position
uid: 'excel!Excel.Interfaces.WorksheetLoadOptions#position:member'
package: excel!
fullName: position
summary: The zero-based position of the worksheet within the workbook.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'position?: boolean;'
return:
type: boolean
- name: protection
uid: 'excel!Excel.Interfaces.WorksheetLoadOptions#protection:member'
package: excel!
fullName: protection
summary: Returns the sheet protection object for a worksheet.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'protection?: Excel.Interfaces.WorksheetProtectionLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.WorksheetProtectionLoadOptions:interface" />'
- name: showGridlines
uid: 'excel!Excel.Interfaces.WorksheetLoadOptions#showGridlines:member'
package: excel!
fullName: showGridlines
summary: Specifies if gridlines are visible to the user.
remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'showGridlines?: boolean;'
return:
type: boolean
- name: showHeadings
uid: 'excel!Excel.Interfaces.WorksheetLoadOptions#showHeadings:member'
package: excel!
fullName: showHeadings
summary: Specifies if headings are visible to the user.
remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'showHeadings?: boolean;'
return:
type: boolean
- name: standardHeight
uid: 'excel!Excel.Interfaces.WorksheetLoadOptions#standardHeight:member'
package: excel!
fullName: standardHeight
summary: 'Returns the standard (default) height of all the rows in the worksheet, in points.'
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'standardHeight?: boolean;'
return:
type: boolean
- name: standardWidth
uid: 'excel!Excel.Interfaces.WorksheetLoadOptions#standardWidth:member'
package: excel!
fullName: standardWidth
summary: >-
Specifies the standard (default) width of all the columns in the worksheet. One unit of column width is equal to
the width of one character in the Normal style. For proportional fonts, the width of the character 0 (zero) is
used.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'standardWidth?: boolean;'
return:
type: boolean
- name: tabColor
uid: 'excel!Excel.Interfaces.WorksheetLoadOptions#tabColor:member'
package: excel!
fullName: tabColor
summary: >-
The tab color of the worksheet. When retrieving the tab color, if the worksheet is invisible, the value will be
`null`<!-- -->. If the worksheet is visible but the tab color is set to auto, an empty string will be returned.
Otherwise, the property will be set to a color, in the form \#RRGGBB (e.g., "FFA500"). When setting the color, use
an empty-string to set an "auto" color, or a real color otherwise.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'tabColor?: boolean;'
return:
type: boolean
- name: tabId
uid: 'excel!Excel.Interfaces.WorksheetLoadOptions#tabId:member'
package: excel!
fullName: tabId
summary: >-
Returns a value representing this worksheet that can be read by Open Office XML. This is an integer value, which
is different from `worksheet.id` (which returns a globally unique identifier) and `worksheet.name` (which returns
a value such as "Sheet1").
remarks: '\[ [API set: ExcelApi 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'tabId?: boolean;'
return:
type: boolean
- name: tables
uid: 'excel!Excel.Interfaces.WorksheetLoadOptions#tables:member'
package: excel!
fullName: tables
summary: Collection of tables that are part of the worksheet.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'tables?: Excel.Interfaces.TableCollectionLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.TableCollectionLoadOptions:interface" />'
- name: visibility
uid: 'excel!Excel.Interfaces.WorksheetLoadOptions#visibility:member'
package: excel!
fullName: visibility
summary: The visibility of the worksheet.
remarks: >-
\[ [API set: ExcelApi 1.1 for reading visibility; 1.2 for setting
it.](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
isPreview: false
isDeprecated: false
syntax:
content: 'visibility?: boolean;'
return:
type: boolean