Package com.grapecity.documents.excel
Interface IFormatCondition
public interface IFormatCondition
代表一个条件格式。
-
Method Summary
Modifier and TypeMethodDescriptionvoiddelete()删除此条件格式。void生成从JSON字符串中的条件格式。返回指定格式规则应用到的单元格范围的IRange对象。返回一个IBorders实例,该实例表示此条件格式的边框。获取在格式条件中使用的TimePeriods日期运算符。getFont()返回一个代表此条件格式的字体实例的IFont。返回此条件格式的第一个公式。返回此条件格式的第二个公式。返回一个IInterior实例,该实例代表此条件格式的背景色。返回如果条件格式规则评估为true时应用到单元格的数字格式(读取或写入对象)。返回此条件格式的运算符。int返回条件格式规则的重优先级值。当工作表中存在多个条件格式规则时,优先级决定了它们的评估顺序。boolean返回一个布尔值,用于确定如果当前规则评估为true时,是否应该对单元格上的附加格式规则进行评估。getText()返回一个字符串值,指定条件格式规则所使用的文本。返回ContainsOperator枚举中的一个常量,指定条件格式规则执行文本搜索的方式。getType()返回此条件格式的类型。voidsetAppliesTo(IRange value) 设置指定格式规则应用到的单元格范围的IRange对象。voidsetDateOperator(TimePeriods value) 设置在格式条件中使用的TimePeriods日期运算符。void设置此条件格式规则的优先级值为"1",以便在工作表上的所有其他规则之前进行评估。voidsetFormula1(Object value) 设置此条件格式的第一个公式。voidsetFormula2(Object value) 设置此条件格式的第二个公式。void设置此条件格式规则的计算顺序,使其在所有工作表上的其他规则之后进行计算。voidsetNumberFormat(String value) 设置当条件格式规则评估为true时应用到单元格的数字格式(读取或写入对象)。void设置此条件格式的运算符。voidsetPriority(int value) 设置条件格式规则的首选项值。该优先级决定了当工作表中存在多个条件格式规则时,它们的评估顺序。voidsetStopIfTrue(boolean value) 设置一个布尔值,以确定如果当前规则评估为true,是否应该对单元格上的附加格式规则进行评估。void设置一个字符串值,指定条件格式规则使用的文本。voidsetTextOperator(ContainsOperator value) 设置ContainsOperator枚举中的一个常量,指定条件格式规则执行的文字搜索。toJson()生成一个从条件格式转换而来的JSON字符串。
-
Method Details
-
getAppliesTo
IRange getAppliesTo()返回指定格式规则应用到的单元格范围的IRange对象。 -
setAppliesTo
设置指定格式规则应用到的单元格范围的IRange对象。 -
getBorders
IBorders getBorders()返回一个IBorders实例,该实例表示此条件格式的边框。 -
getDateOperator
TimePeriods getDateOperator()获取在格式条件中使用的TimePeriods日期运算符。 -
setDateOperator
设置在格式条件中使用的TimePeriods日期运算符。 -
getFont
IFont getFont()返回一个代表此条件格式的字体实例的IFont。 -
getFormula1
Object getFormula1()返回此条件格式的第一个公式。 -
setFormula1
设置此条件格式的第一个公式。 -
getFormula2
Object getFormula2()返回此条件格式的第二个公式。 -
setFormula2
设置此条件格式的第二个公式。 -
getInterior
IInterior getInterior()返回一个IInterior实例,该实例代表此条件格式的背景色。 -
getNumberFormat
String getNumberFormat()返回如果条件格式规则评估为true时应用到单元格的数字格式(读取或写入对象)。 -
setNumberFormat
设置当条件格式规则评估为true时应用到单元格的数字格式(读取或写入对象)。 -
getOperator
FormatConditionOperator getOperator()返回此条件格式的运算符。 -
setOperator
设置此条件格式的运算符。 -
getPriority
int getPriority()返回条件格式规则的重优先级值。当工作表中存在多个条件格式规则时,优先级决定了它们的评估顺序。 -
setPriority
void setPriority(int value) 设置条件格式规则的首选项值。该优先级决定了当工作表中存在多个条件格式规则时,它们的评估顺序。设置优先级时,值必须是介于1到工作表上条件格式规则总数之间的正整数。对于工作表上的所有规则来说,优先级必须是唯一的值,因此改变指定条件格式规则的优先级可能会导致工作表上其他规则优先级值的调整。
-
getStopIfTrue
boolean getStopIfTrue()返回一个布尔值,用于确定如果当前规则评估为true时,是否应该对单元格上的附加格式规则进行评估。 -
setStopIfTrue
void setStopIfTrue(boolean value) 设置一个布尔值,以确定如果当前规则评估为true,是否应该对单元格上的附加格式规则进行评估。 -
getText
String getText()返回一个字符串值,指定条件格式规则所使用的文本。 -
setText
设置一个字符串值,指定条件格式规则使用的文本。如果Type属性未设置为TextString,则忽略此属性。
-
getTextOperator
ContainsOperator getTextOperator()返回ContainsOperator枚举中的一个常量,指定条件格式规则执行文本搜索的方式。 -
setTextOperator
设置ContainsOperator枚举中的一个常量,指定条件格式规则执行的文字搜索。 -
getType
FormatConditionType getType()返回此条件格式的类型。 -
delete
void delete()删除此条件格式。 -
setFirstPriority
void setFirstPriority()设置此条件格式规则的优先级值为"1",以便在工作表上的所有其他规则之前进行评估。 -
setLastPriority
void setLastPriority()设置此条件格式规则的计算顺序,使其在所有工作表上的其他规则之后进行计算。 -
fromJson
生成从JSON字符串中的条件格式。- Parameters:
json- JSON字符串。
-
toJson
String toJson()生成一个从条件格式转换而来的JSON字符串。- Returns:
- 条件格式的JSON字符串。
-