public interface ITop10
| 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 the
IRange object that specifies the cell range to which the
formatting rule is applied. |
IBorders |
getBorders()
Returns an instance of
IBorders which represents the borders of this
conditional format. |
IFont |
getFont()
Returns an instance of
IFont which represents the font of this
conditional format. |
IInterior |
getInterior()
Returns an instance of
IInterior which represents the background
color of this conditional format. |
java.lang.String |
getNumberFormat()
Returns the number format applied to a cell if the conditional formatting
rule evaluates to True.
|
boolean |
getPercent()
Returns a Boolean value, specifying if the rank is determined by a percentage
value.
|
int |
getPriority()
Returns the priority value of the conditional formatting rule.
|
int |
getRank()
Returns an Integer value, specifying either the number or percentage of the
rank value for the conditional format rule.
|
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.
|
TopBottom |
getTopBottom()
Returns one of the constants of the
TopBottom enumeration,
determining if the ranking is evaluated from the top or bottom. |
FormatConditionType |
getType()
Returns the type of this conditional format.
|
void |
setAppliesTo(IRange value)
Sets the
IRange 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 |
setLastPriority()
Sets the evaluation order for this conditional formatting rule so it is
evaluated after all other rules on the worksheet.
|
void |
setNumberFormat(java.lang.String value)
Sets the number format applied to a cell if the conditional formatting rule
evaluates to True.
|
void |
setPercent(boolean value)
Sets a Boolean value, specifying if the rank is determined by a percentage
value.
|
void |
setPriority(int value)
Sets the priority value of the conditional formatting rule.
|
void |
setRank(int value)
Sets an Integer value, specifying either the number or percentage of the rank
value for the conditional format rule.
|
void |
setStopIfTrue(boolean value)
Sets a Boolean value that determines if additional formatting rules on the
cell should be evaluated if the current rule evaluates to True.
|
void |
setTopBottom(TopBottom value)
Sets one of the constants of the
TopBottom enumeration, determining
if the ranking is evaluated from the top or bottom. |
java.lang.String |
toJson()
Generates a json string from the conditional format.
|
IRange getAppliesTo()
IRange object that specifies the cell range to which the
formatting rule is applied.void setAppliesTo(IRange value)
IRange object that specifies the cell range to which the
formatting rule is applied.IBorders getBorders()
IBorders which represents the borders of this
conditional format.IFont getFont()
IFont which represents the font of this
conditional format.IInterior getInterior()
IInterior which represents the background
color of this conditional format.java.lang.String getNumberFormat()
void setNumberFormat(java.lang.String value)
boolean getPercent()
void setPercent(boolean value)
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.
int getRank()
void setRank(int value)
boolean getStopIfTrue()
void setStopIfTrue(boolean value)
TopBottom getTopBottom()
TopBottom enumeration,
determining if the ranking is evaluated from the top or bottom.void setTopBottom(TopBottom value)
TopBottom enumeration, determining
if the ranking is evaluated from the top or bottom.FormatConditionType getType()
void delete()
void setFirstPriority()
void setLastPriority()
void fromJson(java.lang.String json)
json - the json stringjava.lang.String toJson()