Method Details

• getAppliesTo

  IRange getAppliesTo()

  Returns a Range object that specifies the cell range to which the formatting rule is applied.

• setAppliesTo

  void setAppliesTo(IRange value)

  Sets a Range object that specifies the cell range to which the formatting rule is applied.

• getColorScaleCriteria

  IColorScaleCriteria getColorScaleCriteria()

  Returns a ColorScaleCriteria object, which is a collection of individual ColorScaleCriterion objects. The ColorScaleCriterion object specifies the type, value, and color of threshold criteria used in the color scale 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.

  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.

• 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.

• 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.