-
Notifications
You must be signed in to change notification settings - Fork 61
/
excel.cellpropertiesfontloadoptions.yml
168 lines (158 loc) · 5.75 KB
/
excel.cellpropertiesfontloadoptions.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
### YamlMime:TSType
name: Excel.CellPropertiesFontLoadOptions
uid: 'excel!Excel.CellPropertiesFontLoadOptions:interface'
package: excel!
fullName: Excel.CellPropertiesFontLoadOptions
summary: Specifies which properties to load on the `format.font` object.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
- name: bold
uid: 'excel!Excel.CellPropertiesFontLoadOptions#bold:member'
package: excel!
fullName: bold
summary: Specifies whether to load the `bold` property.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'bold?: boolean;'
return:
type: boolean
- name: color
uid: 'excel!Excel.CellPropertiesFontLoadOptions#color:member'
package: excel!
fullName: color
summary: Specifies whether to load the `color` property.
remarks: >-
\[ [API set: ExcelApi 1.9](/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 cell = context.workbook.getActiveCell();
// Define the cell properties to get by setting the matching LoadOptions to true.
const propertiesToGet = cell.getCellProperties({
address: true,
format: {
fill: {
color: true
},
font: {
color: true
}
},
style: true
});
// Sync to get the data from the workbook.
await context.sync();
const cellProperties = propertiesToGet.value[0][0];
console.log(
`Address: ${cellProperties.address}\nStyle: ${cellProperties.style}\nFill Color: ${cellProperties.format.fill.color}\nFont Color: ${cellProperties.format.font.color}`);
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'color?: boolean;'
return:
type: boolean
- name: italic
uid: 'excel!Excel.CellPropertiesFontLoadOptions#italic:member'
package: excel!
fullName: italic
summary: Specifies whether to load the `italic` property.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'italic?: boolean;'
return:
type: boolean
- name: name
uid: 'excel!Excel.CellPropertiesFontLoadOptions#name:member'
package: excel!
fullName: name
summary: Specifies whether to load the `name` property.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'name?: boolean;'
return:
type: boolean
- name: size
uid: 'excel!Excel.CellPropertiesFontLoadOptions#size:member'
package: excel!
fullName: size
summary: Specifies whether to load the `size` property.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'size?: boolean;'
return:
type: boolean
- name: strikethrough
uid: 'excel!Excel.CellPropertiesFontLoadOptions#strikethrough:member'
package: excel!
fullName: strikethrough
summary: Specifies whether to load the `strikethrough` property.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'strikethrough?: boolean;'
return:
type: boolean
- name: subscript
uid: 'excel!Excel.CellPropertiesFontLoadOptions#subscript:member'
package: excel!
fullName: subscript
summary: Specifies whether to load the `subscript` property.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'subscript?: boolean;'
return:
type: boolean
- name: superscript
uid: 'excel!Excel.CellPropertiesFontLoadOptions#superscript:member'
package: excel!
fullName: superscript
summary: Specifies whether to load the `superscript` property.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'superscript?: boolean;'
return:
type: boolean
- name: tintAndShade
uid: 'excel!Excel.CellPropertiesFontLoadOptions#tintAndShade:member'
package: excel!
fullName: tintAndShade
summary: Specifies whether to load the `tintAndShade` property.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'tintAndShade?: boolean;'
return:
type: boolean
- name: underline
uid: 'excel!Excel.CellPropertiesFontLoadOptions#underline:member'
package: excel!
fullName: underline
summary: Specifies whether to load the `underline` property.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'underline?: boolean;'
return:
type: boolean