-
Notifications
You must be signed in to change notification settings - Fork 62
/
excel.interfaces.conditionalformatloadoptions.yml
283 lines (283 loc) · 14.1 KB
/
excel.interfaces.conditionalformatloadoptions.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
### YamlMime:TSType
name: Excel.Interfaces.ConditionalFormatLoadOptions
uid: 'excel!Excel.Interfaces.ConditionalFormatLoadOptions:interface'
package: excel!
fullName: Excel.Interfaces.ConditionalFormatLoadOptions
summary: >-
An object encapsulating a conditional format's range, format, rule, and other properties. To learn more about the
conditional formatting object model, read [Apply conditional formatting to Excel
ranges](https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-conditional-formatting)<!-- -->.
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
- name: $all
uid: 'excel!Excel.Interfaces.ConditionalFormatLoadOptions#$all:member'
package: excel!
fullName: $all
summary: >-
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`<!-- -->) but not the
navigational properties (e.g.: `Range.format.fill.color`<!-- -->).
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: '$all?: boolean;'
return:
type: boolean
- name: cellValue
uid: 'excel!Excel.Interfaces.ConditionalFormatLoadOptions#cellValue:member'
package: excel!
fullName: cellValue
summary: Returns the cell value conditional format properties if the current conditional format is a `CellValue` type.
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'cellValue?: Excel.Interfaces.CellValueConditionalFormatLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.CellValueConditionalFormatLoadOptions:interface" />'
- name: cellValueOrNullObject
uid: 'excel!Excel.Interfaces.ConditionalFormatLoadOptions#cellValueOrNullObject:member'
package: excel!
fullName: cellValueOrNullObject
summary: Returns the cell value conditional format properties if the current conditional format is a `CellValue` type.
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'cellValueOrNullObject?: Excel.Interfaces.CellValueConditionalFormatLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.CellValueConditionalFormatLoadOptions:interface" />'
- name: colorScale
uid: 'excel!Excel.Interfaces.ConditionalFormatLoadOptions#colorScale:member'
package: excel!
fullName: colorScale
summary: Returns the color scale conditional format properties if the current conditional format is a `ColorScale` type.
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'colorScale?: Excel.Interfaces.ColorScaleConditionalFormatLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.ColorScaleConditionalFormatLoadOptions:interface" />'
- name: colorScaleOrNullObject
uid: 'excel!Excel.Interfaces.ConditionalFormatLoadOptions#colorScaleOrNullObject:member'
package: excel!
fullName: colorScaleOrNullObject
summary: Returns the color scale conditional format properties if the current conditional format is a `ColorScale` type.
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'colorScaleOrNullObject?: Excel.Interfaces.ColorScaleConditionalFormatLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.ColorScaleConditionalFormatLoadOptions:interface" />'
- name: custom
uid: 'excel!Excel.Interfaces.ConditionalFormatLoadOptions#custom:member'
package: excel!
fullName: custom
summary: Returns the custom conditional format properties if the current conditional format is a custom type.
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'custom?: Excel.Interfaces.CustomConditionalFormatLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.CustomConditionalFormatLoadOptions:interface" />'
- name: customOrNullObject
uid: 'excel!Excel.Interfaces.ConditionalFormatLoadOptions#customOrNullObject:member'
package: excel!
fullName: customOrNullObject
summary: Returns the custom conditional format properties if the current conditional format is a custom type.
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'customOrNullObject?: Excel.Interfaces.CustomConditionalFormatLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.CustomConditionalFormatLoadOptions:interface" />'
- name: dataBar
uid: 'excel!Excel.Interfaces.ConditionalFormatLoadOptions#dataBar:member'
package: excel!
fullName: dataBar
summary: Returns the data bar properties if the current conditional format is a data bar.
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'dataBar?: Excel.Interfaces.DataBarConditionalFormatLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.DataBarConditionalFormatLoadOptions:interface" />'
- name: dataBarOrNullObject
uid: 'excel!Excel.Interfaces.ConditionalFormatLoadOptions#dataBarOrNullObject:member'
package: excel!
fullName: dataBarOrNullObject
summary: Returns the data bar properties if the current conditional format is a data bar.
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'dataBarOrNullObject?: Excel.Interfaces.DataBarConditionalFormatLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.DataBarConditionalFormatLoadOptions:interface" />'
- name: iconSet
uid: 'excel!Excel.Interfaces.ConditionalFormatLoadOptions#iconSet:member'
package: excel!
fullName: iconSet
summary: Returns the icon set conditional format properties if the current conditional format is an `IconSet` type.
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'iconSet?: Excel.Interfaces.IconSetConditionalFormatLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.IconSetConditionalFormatLoadOptions:interface" />'
- name: iconSetOrNullObject
uid: 'excel!Excel.Interfaces.ConditionalFormatLoadOptions#iconSetOrNullObject:member'
package: excel!
fullName: iconSetOrNullObject
summary: Returns the icon set conditional format properties if the current conditional format is an `IconSet` type.
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'iconSetOrNullObject?: Excel.Interfaces.IconSetConditionalFormatLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.IconSetConditionalFormatLoadOptions:interface" />'
- name: id
uid: 'excel!Excel.Interfaces.ConditionalFormatLoadOptions#id:member'
package: excel!
fullName: id
summary: The priority of the conditional format in the current `ConditionalFormatCollection`<!-- -->.
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'id?: boolean;'
return:
type: boolean
- name: preset
uid: 'excel!Excel.Interfaces.ConditionalFormatLoadOptions#preset:member'
package: excel!
fullName: preset
summary: Returns the preset criteria conditional format. See `Excel.PresetCriteriaConditionalFormat` for more details.
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'preset?: Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions:interface" />'
- name: presetOrNullObject
uid: 'excel!Excel.Interfaces.ConditionalFormatLoadOptions#presetOrNullObject:member'
package: excel!
fullName: presetOrNullObject
summary: Returns the preset criteria conditional format. See `Excel.PresetCriteriaConditionalFormat` for more details.
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'presetOrNullObject?: Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions:interface" />'
- name: priority
uid: 'excel!Excel.Interfaces.ConditionalFormatLoadOptions#priority:member'
package: excel!
fullName: priority
summary: >-
The priority (or index) within the conditional format collection that this conditional format currently exists in.
Changing this also changes other conditional formats' priorities, to allow for a contiguous priority order. Use a
negative priority to begin from the back. Priorities greater than the bounds will get and set to the maximum (or
minimum if negative) priority. Also note that if you change the priority, you have to re-fetch a new copy of the
object at that new priority location if you want to make further changes to it.
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'priority?: boolean;'
return:
type: boolean
- name: stopIfTrue
uid: 'excel!Excel.Interfaces.ConditionalFormatLoadOptions#stopIfTrue:member'
package: excel!
fullName: stopIfTrue
summary: >-
If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell.
Value is `null` on data bars, icon sets, and color scales as there's no concept of `StopIfTrue` for these.
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'stopIfTrue?: boolean;'
return:
type: boolean
- name: textComparison
uid: 'excel!Excel.Interfaces.ConditionalFormatLoadOptions#textComparison:member'
package: excel!
fullName: textComparison
summary: >-
Returns the specific text conditional format properties if the current conditional format is a text type. For
example, to format cells matching the word "Text".
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'textComparison?: Excel.Interfaces.TextConditionalFormatLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.TextConditionalFormatLoadOptions:interface" />'
- name: textComparisonOrNullObject
uid: 'excel!Excel.Interfaces.ConditionalFormatLoadOptions#textComparisonOrNullObject:member'
package: excel!
fullName: textComparisonOrNullObject
summary: >-
Returns the specific text conditional format properties if the current conditional format is a text type. For
example, to format cells matching the word "Text".
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'textComparisonOrNullObject?: Excel.Interfaces.TextConditionalFormatLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.TextConditionalFormatLoadOptions:interface" />'
- name: topBottom
uid: 'excel!Excel.Interfaces.ConditionalFormatLoadOptions#topBottom:member'
package: excel!
fullName: topBottom
summary: >-
Returns the top/bottom conditional format properties if the current conditional format is a `TopBottom` type. For
example, to format the top 10% or bottom 10 items.
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'topBottom?: Excel.Interfaces.TopBottomConditionalFormatLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.TopBottomConditionalFormatLoadOptions:interface" />'
- name: topBottomOrNullObject
uid: 'excel!Excel.Interfaces.ConditionalFormatLoadOptions#topBottomOrNullObject:member'
package: excel!
fullName: topBottomOrNullObject
summary: >-
Returns the top/bottom conditional format properties if the current conditional format is a `TopBottom` type. For
example, to format the top 10% or bottom 10 items.
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'topBottomOrNullObject?: Excel.Interfaces.TopBottomConditionalFormatLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.TopBottomConditionalFormatLoadOptions:interface" />'
- name: type
uid: 'excel!Excel.Interfaces.ConditionalFormatLoadOptions#type:member'
package: excel!
fullName: type
summary: A type of conditional format. Only one can be set at a time.
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'type?: boolean;'
return:
type: boolean