public interface IFormatCondition
Represents a conditional format.
Method Summary
All Methods Instance Methods Abstract Methods
void
Deletes this conditional format.
void
Generates the conditional format from the json string.
Returns the
IRange
object that specifies the cell range to which theformatting rule is applied.
Returns an instance of
IBorders
which represents the borders of thisconditional format.
Gets the
TimePeriods
Date operator used in the format condition.
Returns an instance of
IFont
which represents the font of thisconditional format.
Returns the first formula of this conditional format.
Returns the second formula of this conditional format.
Returns an instance of
IInterior
which represents the backgroundcolor of this conditional format.
Returns the number format applied to a cell if the conditional formatting rule evaluates to True (read or write object).
Returns the operator of this conditional format.
int
Returns the priority value of the conditional formatting rule.
boolean
Returns a Boolean value that determines if additional formatting rules on the cell should be evaluated if the current rule evaluates to True.
Returns a String value specifying the text used by the conditional formatting rule.
Returns one of the constants of the
ContainsOperator
enumeration,specifying the text search performed by the conditional formatting rule.
Returns the type of this conditional format.
void
Sets the
IRange
object that specifies the cell range to which theformatting rule is applied.
void
Sets the
TimePeriods
Date operator used in the format condition.
void
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
Sets the first formula of this conditional format.
void
Sets the second formula of this conditional format.
void
Sets the evaluation order for this conditional formatting rule so it is evaluated after all other rules on the worksheet.
void
Sets the number format applied to a cell if the conditional formatting rule evaluates to True (read or write object).
void
Sets the operator of this conditional format.
void
Sets the priority value of the conditional formatting rule.
void
Sets a Boolean value that determines if additional formatting rules on the cell should be evaluated if the current rule evaluates to True.
void
Sets a String value specifying the text used by the conditional formatting rule.
void
Sets one of the constants of the
ContainsOperator
enumeration,specifying the text search performed by the conditional formatting rule.
Generates a json string from the conditional format.
Method Details
getAppliesTo
Returns the
IRange
object that specifies the cell range to which theformatting rule is applied.
setAppliesTo
void setAppliesTo (IRange value)
Sets the
IRange
object that specifies the cell range to which theformatting rule is applied.
getBorders
Returns an instance of
IBorders
which represents the borders of thisconditional format.
getDateOperator
Gets the
TimePeriods
Date operator used in the format condition.
setDateOperator
Sets the
TimePeriods
Date operator used in the format condition.
getFont
Returns an instance of
IFont
which represents the font of thisconditional format.
getInterior
Returns an instance of
IInterior
which represents the backgroundcolor of this conditional format.
getOperator
Returns the operator of this conditional format.
getPriority
int getPriority ()
Returns the priority value of the conditional formatting rule. The priority determines the order of evaluation when multiple conditional formatting rules exist in a worksheet.
setPriority
void setPriority (int value)
Sets the priority value of the conditional formatting rule. The priority determines the order of evaluation when multiple conditional formatting rules exist in a worksheet.
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.
getStopIfTrue
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.
setStopIfTrue
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.
getText
Returns a String value specifying the text used by the conditional formatting rule.
setText
Sets a String value specifying the text used by the conditional formatting rule.
This property is ignored if the Type property is not set to TextString.
getTextOperator
Returns one of the constants of the
ContainsOperator
enumeration,specifying the text search performed by the conditional formatting rule.
setTextOperator
Sets one of the constants of the
ContainsOperator
enumeration,specifying the text search performed by the conditional formatting rule.
getType
Returns the type of this conditional format.
delete
void delete ()
Deletes this conditional format.
setFirstPriority
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.
setLastPriority
void setLastPriority ()
Sets the evaluation order for this conditional formatting rule so it is evaluated after all other rules on the worksheet.
fromJson
Generates the conditional format from the json string.
Parameters:
json
- the json string.
toJson
Generates a json string from the conditional format.
Returns:
the conditional format json string