public final class TopOrBottomRankedCondition extends FormatCondition
Modifier and Type | Method and Description |
---|---|
FormatConditionType |
getConditionType()
Gets the
FormatConditionType.TOP_OR_BOTTOM_RANKED value. |
int |
getRank()
Gets the number or percentage of top or bottom ranked cells which are formatted.
|
CellStyle |
getStyle()
Gets the actual formatting which will be applied to a cell if its value satisfies this
TopOrBottomRankedCondition . |
boolean |
isBottom()
Gets a value indicating whether to format cells with bottom ranked values.
|
boolean |
isPercent()
Gets a value indicating whether the
rank value is expressed as a percentage of a number of cells in the applied range. |
void |
setBottom(boolean bottom)
Sets a value indicating whether to format cells with bottom ranked values.
|
void |
setPercent(boolean percent)
Sets a value indicating whether the
rank value is expressed as a percentage of a number of cells in the applied range. |
void |
setRank(int value)
Sets the number or percentage of top or bottom ranked cells which are formatted.
|
String |
toString()
Returns a
String that represents this TopOrBottomRankedCondition instance. |
getRule
public FormatConditionType getConditionType()
FormatConditionType.TOP_OR_BOTTOM_RANKED
value.getConditionType
in class FormatCondition
FormatConditionType.TOP_OR_BOTTOM_RANKED
value.public int getRank()
public CellStyle getStyle()
TopOrBottomRankedCondition
.TopOrBottomRankedCondition
.public boolean isBottom()
Gets a value indicating whether to format cells with bottom ranked values.
Default value is false
(formats cells with top ranked values).
true
to format cells with bottom ranked values; otherwise, false
.public boolean isPercent()
Gets a value indicating whether the rank
value is expressed as a percentage of a number of cells in the applied range.
Default value is false
(the rank
value is expressed as a number of cells).
true
if the rank
value is expressed as a percentage of a number of cells in the applied range; otherwise, false
.public void setBottom(boolean bottom)
Sets a value indicating whether to format cells with bottom ranked values.
Default value is false
(formats cells with top ranked values).
bottom
- true
to format cells with bottom ranked values; otherwise, false
.public void setPercent(boolean percent)
Sets a value indicating whether the rank
value is expressed as a percentage of a number of cells in the applied range.
Default value is false
(the rank
value is expressed as a number of cells).
percent
- true
if the rank
value is expressed as a percentage of a number of cells in the applied range; otherwise, false
.public void setRank(int value)
value
- The number or percentage of top or bottom ranked cells which are formatted.IndexOutOfBoundsException
- Value is less than or equal to zero.public String toString()
String
that represents this TopOrBottomRankedCondition
instance.
This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).
toString
in class FormatCondition
String
that represents this TopOrBottomRankedCondition
instance.© GemBox Ltd. — All rights reserved.