-
Notifications
You must be signed in to change notification settings - Fork 63
/
excel.cellpropertiesfillloadoptions.yml
108 lines (98 loc) · 3.7 KB
/
excel.cellpropertiesfillloadoptions.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
### YamlMime:TSType
name: Excel.CellPropertiesFillLoadOptions
uid: 'excel!Excel.CellPropertiesFillLoadOptions:interface'
package: excel!
fullName: Excel.CellPropertiesFillLoadOptions
summary: Specifies which properties to load on the `format.fill` object.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
- name: color
uid: 'excel!Excel.CellPropertiesFillLoadOptions#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: pattern
uid: 'excel!Excel.CellPropertiesFillLoadOptions#pattern:member'
package: excel!
fullName: pattern
summary: Specifies whether to load the `pattern` property.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'pattern?: boolean;'
return:
type: boolean
- name: patternColor
uid: 'excel!Excel.CellPropertiesFillLoadOptions#patternColor:member'
package: excel!
fullName: patternColor
summary: Specifies whether to load the `patternColor` property.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'patternColor?: boolean;'
return:
type: boolean
- name: patternTintAndShade
uid: 'excel!Excel.CellPropertiesFillLoadOptions#patternTintAndShade:member'
package: excel!
fullName: patternTintAndShade
summary: Specifies whether to load the `patternTintAndShade` property.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'patternTintAndShade?: boolean;'
return:
type: boolean
- name: tintAndShade
uid: 'excel!Excel.CellPropertiesFillLoadOptions#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