Method Summary

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.

• getFont

  IFont getFont()

  Returns an instance of IFont which represents the font of thisconditional 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.

• setNumberFormat

  void setNumberFormat(String value)

  Sets the number format applied to a cell if the conditional formatting rule evaluates to True.

• getPercent

  boolean getPercent()

  Returns a Boolean value, specifying if the rank is determined by a percentage value.

• setPercent

  void setPercent(boolean value)

  Sets a Boolean value, specifying if the rank is determined by a percentage value.

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

• getRank

  int getRank()

  Returns an Integer value, specifying either the number or percentage of the rank value for the conditional format rule.

• setRank

  void setRank(int value)

  Sets an Integer value, specifying either the number or percentage of the rank value for the conditional format rule.

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

• getTopBottom

  TopBottom getTopBottom()

  Returns one of the constants of the TopBottom enumeration,determining if the ranking is evaluated from the top or bottom.

• setTopBottom

  void setTopBottom(TopBottom value)

  Sets one of the constants of the TopBottom enumeration, determiningif the ranking is evaluated from the top or bottom.

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