/
excel.cellpropertiesloadoptions.yml
141 lines (124 loc) · 4.37 KB
/
excel.cellpropertiesloadoptions.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
### YamlMime:TSType
name: Excel.CellPropertiesLoadOptions
uid: 'excel!Excel.CellPropertiesLoadOptions:interface'
package: excel!
fullName: Excel.CellPropertiesLoadOptions
summary: |-
Represents which cell properties to load, when used as part of a "range.getCellProperties" method.
\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
- name: address
uid: 'excel!Excel.CellPropertiesLoadOptions#address:member'
package: excel!
fullName: address
summary: |-
Specifies whether to load on the `address` property.
\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'address?: boolean;'
return:
type: boolean
description: >-
#### 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}`);
});
```
- name: addressLocal
uid: 'excel!Excel.CellPropertiesLoadOptions#addressLocal:member'
package: excel!
fullName: addressLocal
summary: |-
Specifies whether to load on the `addressLocal` property.
\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'addressLocal?: boolean;'
return:
type: boolean
- name: format
uid: 'excel!Excel.CellPropertiesLoadOptions#format:member'
package: excel!
fullName: format
summary: |-
Specifies whether to load on the `format` property.
\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'format?: Excel.CellPropertiesFormatLoadOptions;'
return:
type: '<xref uid="excel!Excel.CellPropertiesFormatLoadOptions:interface" />'
- name: hidden
uid: 'excel!Excel.CellPropertiesLoadOptions#hidden:member'
package: excel!
fullName: hidden
summary: |-
Specifies whether to load on the `hidden` property.
\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'hidden?: boolean;'
return:
type: boolean
- name: hyperlink
uid: 'excel!Excel.CellPropertiesLoadOptions#hyperlink:member'
package: excel!
fullName: hyperlink
summary: |-
Specifies whether to load on the `hyperlink` property.
\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'hyperlink?: boolean;'
return:
type: boolean
- name: style
uid: 'excel!Excel.CellPropertiesLoadOptions#style:member'
package: excel!
fullName: style
summary: |-
Specifies whether to load on the `style` property.
\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'style?: boolean;'
return:
type: boolean