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.

• getIconCriteria

  IIconCriteria getIconCriteria()

  Returns an IconCriteria collection, which represents the set of criteria for an icon set conditional formatting rule.

• getIconSet

  IIconSet getIconSet()

  Returns an IconSets collection, which specifies the icon set used in the conditional format.

• setIconSet

  void setIconSet(IIconSet value)

  Sets an IconSets collection, which specifies the icon set used in the conditional format.

• getPercentileValues

  boolean getPercentileValues()

  Returns a Boolean value indicating if the thresholds for an icon set conditional format are determined by using percentiles.

• setPercentileValues

  void setPercentileValues(boolean value)

  Sets a Boolean value indicating if the thresholds for an icon set conditional format are determined by using percentiles.

  This property will return False if not every threshold is set to percentile. Setting this property to True will set every threshold type to percentile.

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

• getReverseOrder

  boolean getReverseOrder()

  Returns a Boolean value indicating if the order of icons is reversed for an icon set.

• setReverseOrder

  void setReverseOrder(boolean value)

  Sets a Boolean value indicating if the order of icons is reversed for an icon set.

• getShowIconOnly

  boolean getShowIconOnly()

  Returns a Boolean value indicating if only the icon is displayed for an icon set conditional format.

• setShowIconOnly

  void setShowIconOnly(boolean value)

  Sets a Boolean value indicating if only the icon is displayed for an icon set conditional format.

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

• getCustom

  boolean getCustom()

  Returns a Boolean value indicating if this is a custom iconset condition

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