-
Notifications
You must be signed in to change notification settings - Fork 63
/
excel.builtinstyle.yml
355 lines (340 loc) · 14.7 KB
/
excel.builtinstyle.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
### YamlMime:TSEnum
name: Excel.BuiltInStyle
uid: 'excel!Excel.BuiltInStyle:enum'
package: excel!
fullName: Excel.BuiltInStyle
summary: ''
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/42-range/cell-properties.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getActiveWorksheet();
// Creating the SettableCellProperties objects to use for the range.
// In your add-in, these should be created once, outside the function.
const topHeaderProps: Excel.SettableCellProperties = {
// The style property takes a string matching the name of an Excel style.
// Built-in style names are listed in the `BuiltInStyle` enum.
// Note that a style will overwrite any formatting,
// so do not use the format property with the style property.
style: "Heading1"
};
const headerProps: Excel.SettableCellProperties = {
// Any subproperties of format that are not set will not be changed when these cell properties are set.
format: {
fill: {
color: "Blue"
},
font: {
color: "White",
bold: true
}
}
};
const nonApplicableProps: Excel.SettableCellProperties = {
format: {
fill: {
pattern: Excel.FillPattern.gray25
},
font: {
color: "Gray",
italic: true
}
}
};
const matchupScoreProps: Excel.SettableCellProperties = {
format: {
borders: {
bottom: {
style: Excel.BorderLineStyle.continuous
},
left: {
style: Excel.BorderLineStyle.continuous
},
right: {
style: Excel.BorderLineStyle.continuous
},
top: {
style: Excel.BorderLineStyle.continuous
}
}
}
};
const range = sheet.getRange("A1:E5");
// You can use empty JSON objects to avoid changing a cell's properties.
range.setCellProperties([
[topHeaderProps, {}, {}, {}, {}],
[{}, {}, headerProps, headerProps, headerProps],
[{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps],
[{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps],
[{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps]
]);
sheet.getUsedRange().format.autofitColumns();
await context.sync();
});
```
isPreview: false
isDeprecated: false
fields:
- name: accent1
uid: 'excel!Excel.BuiltInStyle.accent1:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Accent1"'
- name: accent1_20
uid: 'excel!Excel.BuiltInStyle.accent1_20:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Accent1_20"'
- name: accent1_40
uid: 'excel!Excel.BuiltInStyle.accent1_40:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Accent1_40"'
- name: accent1_60
uid: 'excel!Excel.BuiltInStyle.accent1_60:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Accent1_60"'
- name: accent2
uid: 'excel!Excel.BuiltInStyle.accent2:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Accent2"'
- name: accent2_20
uid: 'excel!Excel.BuiltInStyle.accent2_20:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Accent2_20"'
- name: accent2_40
uid: 'excel!Excel.BuiltInStyle.accent2_40:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Accent2_40"'
- name: accent2_60
uid: 'excel!Excel.BuiltInStyle.accent2_60:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Accent2_60"'
- name: accent3
uid: 'excel!Excel.BuiltInStyle.accent3:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Accent3"'
- name: accent3_20
uid: 'excel!Excel.BuiltInStyle.accent3_20:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Accent3_20"'
- name: accent3_40
uid: 'excel!Excel.BuiltInStyle.accent3_40:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Accent3_40"'
- name: accent3_60
uid: 'excel!Excel.BuiltInStyle.accent3_60:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Accent3_60"'
- name: accent4
uid: 'excel!Excel.BuiltInStyle.accent4:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Accent4"'
- name: accent4_20
uid: 'excel!Excel.BuiltInStyle.accent4_20:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Accent4_20"'
- name: accent4_40
uid: 'excel!Excel.BuiltInStyle.accent4_40:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Accent4_40"'
- name: accent4_60
uid: 'excel!Excel.BuiltInStyle.accent4_60:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Accent4_60"'
- name: accent5
uid: 'excel!Excel.BuiltInStyle.accent5:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Accent5"'
- name: accent5_20
uid: 'excel!Excel.BuiltInStyle.accent5_20:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Accent5_20"'
- name: accent5_40
uid: 'excel!Excel.BuiltInStyle.accent5_40:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Accent5_40"'
- name: accent5_60
uid: 'excel!Excel.BuiltInStyle.accent5_60:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Accent5_60"'
- name: accent6
uid: 'excel!Excel.BuiltInStyle.accent6:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Accent6"'
- name: accent6_20
uid: 'excel!Excel.BuiltInStyle.accent6_20:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Accent6_20"'
- name: accent6_40
uid: 'excel!Excel.BuiltInStyle.accent6_40:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Accent6_40"'
- name: accent6_60
uid: 'excel!Excel.BuiltInStyle.accent6_60:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Accent6_60"'
- name: bad
uid: 'excel!Excel.BuiltInStyle.bad:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Bad"'
- name: calculation
uid: 'excel!Excel.BuiltInStyle.calculation:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Calculation"'
- name: checkCell
uid: 'excel!Excel.BuiltInStyle.checkCell:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"CheckCell"'
- name: comma
uid: 'excel!Excel.BuiltInStyle.comma:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Comma"'
- name: currency
uid: 'excel!Excel.BuiltInStyle.currency:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Currency"'
- name: emphasis1
uid: 'excel!Excel.BuiltInStyle.emphasis1:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Emphasis1"'
- name: emphasis2
uid: 'excel!Excel.BuiltInStyle.emphasis2:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Emphasis2"'
- name: emphasis3
uid: 'excel!Excel.BuiltInStyle.emphasis3:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Emphasis3"'
- name: explanatoryText
uid: 'excel!Excel.BuiltInStyle.explanatoryText:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"ExplanatoryText"'
- name: good
uid: 'excel!Excel.BuiltInStyle.good:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Good"'
- name: heading1
uid: 'excel!Excel.BuiltInStyle.heading1:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Heading1"'
- name: heading2
uid: 'excel!Excel.BuiltInStyle.heading2:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Heading2"'
- name: heading3
uid: 'excel!Excel.BuiltInStyle.heading3:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Heading3"'
- name: heading4
uid: 'excel!Excel.BuiltInStyle.heading4:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Heading4"'
- name: hlink
uid: 'excel!Excel.BuiltInStyle.hlink:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Hlink"'
- name: hlinkTrav
uid: 'excel!Excel.BuiltInStyle.hlinkTrav:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"HlinkTrav"'
- name: input
uid: 'excel!Excel.BuiltInStyle.input:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Input"'
- name: linkedCell
uid: 'excel!Excel.BuiltInStyle.linkedCell:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"LinkedCell"'
- name: neutral
uid: 'excel!Excel.BuiltInStyle.neutral:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Neutral"'
- name: normal
uid: 'excel!Excel.BuiltInStyle.normal:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Normal"'
- name: note
uid: 'excel!Excel.BuiltInStyle.note:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Note"'
- name: output
uid: 'excel!Excel.BuiltInStyle.output:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Output"'
- name: percent
uid: 'excel!Excel.BuiltInStyle.percent:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Percent"'
- name: sheetTitle
uid: 'excel!Excel.BuiltInStyle.sheetTitle:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"SheetTitle"'
- name: total
uid: 'excel!Excel.BuiltInStyle.total:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Total"'
- name: warningText
uid: 'excel!Excel.BuiltInStyle.warningText:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"WarningText"'
- name: wholeComma
uid: 'excel!Excel.BuiltInStyle.wholeComma:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"WholeComma"'
- name: wholeDollar
uid: 'excel!Excel.BuiltInStyle.wholeDollar:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"WholeDollar"'