Package com.grapecity.documents.excel

Interface IFormatCondition

public interface IFormatCondition

Represents a conditional format.

Method Summary

Modifier and Type	Method	Description
void	delete()	Deletes this conditional format.
void	fromJson(String json)	Generates the conditional format from the json string.
IRange	getAppliesTo()	Returns the IRange object that specifies the cell range to which theformatting rule is applied.
IBorders	getBorders()	Returns an instance of IBorders which represents the borders of thisconditional format.
TimePeriods	getDateOperator()	Gets the TimePeriods Date operator used in the format condition.
IFont	getFont()	Returns an instance of IFont which represents the font of thisconditional format.
Object	getFormula1()	Returns the first formula of this conditional format.
Object	getFormula2()	Returns the second formula of this conditional format.
IInterior	getInterior()	Returns an instance of IInterior which represents the backgroundcolor of this conditional format.
String	getNumberFormat()	Returns the number format applied to a cell if the conditional formatting rule evaluates to True (read or write object).
FormatConditionOperator	getOperator()	Returns the operator of this conditional format.
int	getPriority()	Returns the priority value of the conditional formatting 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.
String	getText()	Returns a String value specifying the text used by the conditional formatting rule.
ContainsOperator	getTextOperator()	Returns one of the constants of the ContainsOperator enumeration,specifying the text search performed by the conditional formatting rule.
FormatConditionType	getType()	Returns the type of this conditional format.
void	setAppliesTo(IRange value)	Sets the IRange object that specifies the cell range to which theformatting rule is applied.
void	setDateOperator(TimePeriods value)	Sets the TimePeriods Date operator used in the format condition.
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	setFormula1(Object value)	Sets the first formula of this conditional format.
void	setFormula2(Object value)	Sets the second formula of this 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	setNumberFormat(String value)	Sets the number format applied to a cell if the conditional formatting rule evaluates to True (read or write object).
void	setOperator(FormatConditionOperator value)	Sets the operator of this conditional format.
void	setPriority(int value)	Sets the priority value of the conditional formatting 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	setText(String value)	Sets a String value specifying the text used by the conditional formatting rule.
void	setTextOperator(ContainsOperator value)	Sets one of the constants of the ContainsOperator enumeration,specifying the text search performed by the conditional formatting rule.
String	toJson()	Generates a json string from the conditional format.

Method Details

getAppliesTo

IRange 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

IBorders getBorders()

Returns an instance of IBorders which represents the borders of thisconditional format.

getDateOperator

TimePeriods getDateOperator()

Gets the TimePeriods Date operator used in the format condition.

setDateOperator

void setDateOperator(TimePeriods value)

Sets the TimePeriods Date operator used in the format condition.

getFont

IFont getFont()

Returns an instance of IFont which represents the font of thisconditional format.

getFormula1

Object getFormula1()

Returns the first formula of this conditional format.

setFormula1

void setFormula1(Object value)

Sets the first formula of this conditional format.

getFormula2

Object getFormula2()

Returns the second formula of this conditional format.

setFormula2

void setFormula2(Object value)

Sets the second formula of this conditional format.

getInterior

IInterior getInterior()

Returns an instance of IInterior which represents the backgroundcolor of this conditional format.

getNumberFormat

String getNumberFormat()

Returns the number format applied to a cell if the conditional formatting rule evaluates to True (read or write object).

setNumberFormat

void setNumberFormat(String value)

Sets the number format applied to a cell if the conditional formatting rule evaluates to True (read or write object).

getOperator

FormatConditionOperator getOperator()

Returns the operator of this conditional format.

setOperator

void setOperator(FormatConditionOperator value)

Sets 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

String getText()

Returns a String value specifying the text used by the conditional formatting rule.

setText

void setText(String value)

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

ContainsOperator getTextOperator()

Returns one of the constants of the ContainsOperator enumeration,specifying the text search performed by the conditional formatting rule.

setTextOperator

void setTextOperator(ContainsOperator value)

Sets one of the constants of the ContainsOperator enumeration,specifying the text search performed by the conditional formatting rule.

getType

FormatConditionType 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

void fromJson(String json)

Generates the conditional format from the json string.

Parameters:

json - the json string.

toJson

String toJson()

Generates a json string from the conditional format.

Returns:

the conditional format json string