Static $tStatic nextReturns a [[ColorScaleType]] value which identifies this instance as a 2-color or 3-color scale.
A [[ColorScaleConditionalFormat]] instance which is created with the 'TwoColor' value does not support the [[midpointThreshold]]; attempting to set a property on the object retuned from the MidpointThreshold property will cause an exception to be thrown.
Returns a [[FormatConditionType]] value which identifies the type of condition for this instance.
Returns the
[[setFormula]]
Returns a [[ColorScaleCriterion]] object which defines the properties of the maximum threshold for this instance.
The following
Returns a [[ColorScaleCriterion]] object which defines the properties of the midpoint threshold for this instance.
The midpoint threshold is only supported for a [[ColorScaleConditionalFormat]]
instance with a value of 'ThreeColor' specified for the
Attempting to set a property on the instance returned from this property will cause an exception to be thrown if this instance was created as a 2-color scale.
The following
Returns a [[ColorScaleCriterion]] object which defines the properties of the minimum threshold for this instance.
The minimum threshold defines the criteria for the lowest or minimum value across the associated range.
For a 2-color scale, the [[maximumThreshold]] defines the next "stop"; for a 3-color scale, the [[midpointThreshold]] property defines the next stop.
The following
Returns or sets a value which determines the order of evaluation when multiple conditional formatting rules exist.
By default,
This property makes it possible to weight one condition over another, essentially overriding the condition's ordinal position within the collection.
A lower number means a higher priority; for example, a condition with a priority of 1 is evaluated before one with a priority of 2.
If a cell value meets more than one condition, the format defined by the first condition to be evaluated takes precedence.
Setting the priority on one condition may cause the value of other conditions in the collection to be changed to ensure that each condition has a unique value.
Returns the [[WorksheetRegion]] which identifies the cell range with which this condition is associated.
Returns or sets a boolean indicating whether additional formatting rules
are evaluated if this rule evaluates to true. Applicable only in the case
where the containing
If a cell value meets more than one condition, the format defined by the first condition takes precedence. Individual format properties are "merged" during the resolution process; for example, if one format has red borders and another has a red foreground color, a cell value which meets both conditions may be formatted with both red borders and a red foreground color.
This property makes it possible to short-circuit the resolution process, so that no other conditional formats are applied after the first condition evaluates to true.
Using the above example, assume StopIfTrue is set to a value of true on the conditional format with red borders, a second conditional format exists with a red foreground color, and a cell value meets both conditions. Because the StopIfTrue setting prevents additional formats from being evaluated, the cell will not show a red foreground color, whereas with StopIfTrue being set to false, it would show both red borders and a red foreground color.
In addition to preventing subsequent conditions from being evaluated, the order in which conditions are evaluated can be controlled using the [[priority]] property.
Sets the [[priority]] value for this rule such that it
is the first condition to be evaluated. Applicable only in the case
where there is more than one element contained within the associated
When multiple
This method ensures that the associated condition is the first one to be evaluated.
To make a condition the last one to be evaluated, use the [[setLastPriority]] method.
Assigns a new [[Formula]] to the [[formula]] property.
[[formula]]
The string representation of the formula.
A [[CellReferenceMode]] value which specifies whether the 'formula' parameter should be interpreted as an A1 or R1C1 expression. This parameter is optional and defaults to null, in which case the [[Workbook.cellReferenceMode]] property is used.
Sets the [[priority]] value for this rule such that it is the last condition to be evaluated. Applicable only in the case where there is more than one element contained within the associated [[ConditionalFormatCollection]].
Just as the [[setFirstPriority]] method ensures that the associated condition is evalulated first, the SetLastPriority method ensures that the associated condition is evaluated last.
Calling this method on more than one condition essentially replaces the previously designated condition as the last one to be evaluated with this one.
Replaces the existing regions with new ones
[[ArgumentException]] If regionAddress is invalid or contains a region from another worksheet
A string with one or more comma separated region address
An optional cell reference mode
Static compareStatic compareStatic equalsStatic equalsStatic getStatic getStatic getStatic referenceStatic static
Exposes properties which control the coloring of a [[WorksheetCell]] based on the cell's value as relative to minimum, midpoint, and maximum threshold values.
This class support either a 2-color or 3-color scale, as determined by the value of thecolorScaleType
parameter of the constructor.
For 2-color scales, cells in the associated range are colored based on how their value relates to theminimum and maximum
thresholds.
For 3-color scales, cells in the associated range are colored based on how their value relates to the minimum,midpoint , and
maximum thresholds.
This class supports a maximum of three separate and distinct color thresholds.
Specifying only one threshold is not supported and may result in unexpected behavior.
If this instance is created as a 2-color scale, the [[midpointThreshold]] property is not applicable. Attempting to set a property on the object returned from the MidpointThreshold property in this case will cause an exception to be thrown.
See