/
excel.interfaces.styleupdatedata.yml
249 lines (249 loc) · 10.2 KB
/
excel.interfaces.styleupdatedata.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
### YamlMime:TSType
name: Excel.Interfaces.StyleUpdateData
uid: 'excel!Excel.Interfaces.StyleUpdateData:interface'
package: excel!
fullName: Excel.Interfaces.StyleUpdateData
summary: 'An interface for updating data on the Style object, for use in `style.set({ ... })`<!-- -->.'
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
- name: borders
uid: 'excel!Excel.Interfaces.StyleUpdateData#borders:member'
package: excel!
fullName: borders
summary: A collection of four border objects that represent the style of the four borders.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'borders?: Excel.Interfaces.RangeBorderCollectionUpdateData;'
return:
type: '<xref uid="excel!Excel.Interfaces.RangeBorderCollectionUpdateData:interface" />'
- name: fill
uid: 'excel!Excel.Interfaces.StyleUpdateData#fill:member'
package: excel!
fullName: fill
summary: The fill of the style.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'fill?: Excel.Interfaces.RangeFillUpdateData;'
return:
type: '<xref uid="excel!Excel.Interfaces.RangeFillUpdateData:interface" />'
- name: font
uid: 'excel!Excel.Interfaces.StyleUpdateData#font:member'
package: excel!
fullName: font
summary: A `Font` object that represents the font of the style.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'font?: Excel.Interfaces.RangeFontUpdateData;'
return:
type: '<xref uid="excel!Excel.Interfaces.RangeFontUpdateData:interface" />'
- name: formulaHidden
uid: 'excel!Excel.Interfaces.StyleUpdateData#formulaHidden:member'
package: excel!
fullName: formulaHidden
summary: Specifies if the formula will be hidden when the worksheet is protected.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'formulaHidden?: boolean;'
return:
type: boolean
- name: horizontalAlignment
uid: 'excel!Excel.Interfaces.StyleUpdateData#horizontalAlignment:member'
package: excel!
fullName: horizontalAlignment
summary: Represents the horizontal alignment for the style. See `Excel.HorizontalAlignment` for details.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
horizontalAlignment?: Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" |
"CenterAcrossSelection" | "Distributed";
return:
type: >-
<xref uid="excel!Excel.HorizontalAlignment:enum" /> | "General" | "Left" | "Center" | "Right" | "Fill" |
"Justify" | "CenterAcrossSelection" | "Distributed"
- name: includeAlignment
uid: 'excel!Excel.Interfaces.StyleUpdateData#includeAlignment:member'
package: excel!
fullName: includeAlignment
summary: >-
Specifies if the style includes the auto indent, horizontal alignment, vertical alignment, wrap text, indent
level, and text orientation properties.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'includeAlignment?: boolean;'
return:
type: boolean
- name: includeBorder
uid: 'excel!Excel.Interfaces.StyleUpdateData#includeBorder:member'
package: excel!
fullName: includeBorder
summary: 'Specifies if the style includes the color, color index, line style, and weight border properties.'
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'includeBorder?: boolean;'
return:
type: boolean
- name: includeFont
uid: 'excel!Excel.Interfaces.StyleUpdateData#includeFont:member'
package: excel!
fullName: includeFont
summary: >-
Specifies if the style includes the background, bold, color, color index, font style, italic, name, size,
strikethrough, subscript, superscript, and underline font properties.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'includeFont?: boolean;'
return:
type: boolean
- name: includeNumber
uid: 'excel!Excel.Interfaces.StyleUpdateData#includeNumber:member'
package: excel!
fullName: includeNumber
summary: Specifies if the style includes the number format property.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'includeNumber?: boolean;'
return:
type: boolean
- name: includePatterns
uid: 'excel!Excel.Interfaces.StyleUpdateData#includePatterns:member'
package: excel!
fullName: includePatterns
summary: >-
Specifies if the style includes the color, color index, invert if negative, pattern, pattern color, and pattern
color index interior properties.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'includePatterns?: boolean;'
return:
type: boolean
- name: includeProtection
uid: 'excel!Excel.Interfaces.StyleUpdateData#includeProtection:member'
package: excel!
fullName: includeProtection
summary: Specifies if the style includes the formula hidden and locked protection properties.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'includeProtection?: boolean;'
return:
type: boolean
- name: indentLevel
uid: 'excel!Excel.Interfaces.StyleUpdateData#indentLevel:member'
package: excel!
fullName: indentLevel
summary: An integer from 0 to 250 that indicates the indent level for the style.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'indentLevel?: number;'
return:
type: number
- name: locked
uid: 'excel!Excel.Interfaces.StyleUpdateData#locked:member'
package: excel!
fullName: locked
summary: Specifies if the object is locked when the worksheet is protected.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'locked?: boolean;'
return:
type: boolean
- name: numberFormat
uid: 'excel!Excel.Interfaces.StyleUpdateData#numberFormat:member'
package: excel!
fullName: numberFormat
summary: The format code of the number format for the style.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'numberFormat?: string;'
return:
type: string
- name: numberFormatLocal
uid: 'excel!Excel.Interfaces.StyleUpdateData#numberFormatLocal:member'
package: excel!
fullName: numberFormatLocal
summary: The localized format code of the number format for the style.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'numberFormatLocal?: string;'
return:
type: string
- name: readingOrder
uid: 'excel!Excel.Interfaces.StyleUpdateData#readingOrder:member'
package: excel!
fullName: readingOrder
summary: The reading order for the style.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readingOrder?: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft";'
return:
type: '<xref uid="excel!Excel.ReadingOrder:enum" /> | "Context" | "LeftToRight" | "RightToLeft"'
- name: shrinkToFit
uid: 'excel!Excel.Interfaces.StyleUpdateData#shrinkToFit:member'
package: excel!
fullName: shrinkToFit
summary: Specifies if text automatically shrinks to fit in the available column width.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'shrinkToFit?: boolean;'
return:
type: boolean
- name: verticalAlignment
uid: 'excel!Excel.Interfaces.StyleUpdateData#verticalAlignment:member'
package: excel!
fullName: verticalAlignment
summary: Specifies the vertical alignment for the style. See `Excel.VerticalAlignment` for details.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'verticalAlignment?: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed";'
return:
type: '<xref uid="excel!Excel.VerticalAlignment:enum" /> | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"'
- name: wrapText
uid: 'excel!Excel.Interfaces.StyleUpdateData#wrapText:member'
package: excel!
fullName: wrapText
summary: Specifies if Excel wraps the text in the object.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'wrapText?: boolean;'
return:
type: boolean