public interface IIconSetCondition
| Modifier and Type | Method and Description |
|---|---|
void |
delete()
Deletes this conditional format.
|
void |
fromJson(java.lang.String json)
Generates the conditional format from the json string.
|
IRange |
getAppliesTo()
Returns a Range object that specifies the cell range to which the formatting
rule is applied.
|
boolean |
getCustom()
Returns a Boolean value indicating if this is a custom iconset condition
|
IIconCriteria |
getIconCriteria()
Returns an IconCriteria collection, which represents the set of criteria for
an icon set conditional formatting rule.
|
IIconSet |
getIconSet()
Returns an IconSets collection, which specifies the icon set used in the
conditional format.
|
boolean |
getPercentileValues()
Returns a Boolean value indicating if the thresholds for an icon set
conditional format are determined by using percentiles.
|
int |
getPriority()
Returns the priority value of the conditional formatting rule.
|
boolean |
getReverseOrder()
Returns a Boolean value indicating if the order of icons is reversed for an
icon set.
|
boolean |
getShowIconOnly()
Returns a Boolean value indicating if only the icon is displayed for an icon
set conditional format.
|
boolean |
getStopIfTrue()
Returns a Boolean value that determines if additional formatting rules on the
cell should be evaluated if the current rule evaluates to True.
|
FormatConditionType |
getType()
Returns the type of this conditional format.
|
void |
setAppliesTo(IRange value)
Sets a Range object that specifies the cell range to which the formatting
rule is applied.
|
void |
setFirstPriority()
Sets the priority value for this conditional formatting rule to "1" so that
it will be evaluated before all other rules on the worksheet.
|
void |
setIconSet(IIconSet value)
Sets an IconSets collection, which specifies the icon set used in the
conditional format.
|
void |
setLastPriority()
Sets the evaluation order for this conditional formatting rule so it is
evaluated after all other rules on the worksheet.
|
void |
setPercentileValues(boolean value)
Sets a Boolean value indicating if the thresholds for an icon set conditional
format are determined by using percentiles.
|
void |
setPriority(int value)
Sets the priority value of the conditional formatting rule.
|
void |
setReverseOrder(boolean value)
Sets a Boolean value indicating if the order of icons is reversed for an icon
set.
|
void |
setShowIconOnly(boolean value)
Sets a Boolean value indicating if only the icon is displayed for an icon set
conditional format.
|
java.lang.String |
toJson()
Generates a json string from the conditional format.
|
IRange getAppliesTo()
void setAppliesTo(IRange value)
IIconCriteria getIconCriteria()
IIconSet getIconSet()
void setIconSet(IIconSet value)
boolean getPercentileValues()
void setPercentileValues(boolean value)
This property will return False if not every threshold is set to percentile. Setting this property to True will set every threshold type to percentile.
int getPriority()
void setPriority(int value)
When setting the priority, the value must be a positive integer between 1 and the total number of conditional formatting rules on the worksheet. The priority must be a unique value for all rules on the worksheet, so changing the priority for the specified conditional formatting rule may cause the priority value of the other rules on the worksheet to be shifted.
boolean getReverseOrder()
void setReverseOrder(boolean value)
boolean getShowIconOnly()
void setShowIconOnly(boolean value)
boolean getStopIfTrue()
FormatConditionType getType()
void delete()
void setFirstPriority()
void setLastPriority()
boolean getCustom()
void fromJson(java.lang.String json)
json - the json stringjava.lang.String toJson()