Interface IUniqueValues

public interface IUniqueValues

The UniqueValues object uses the UniqueValues.DupeUnique property to return or set an enumeration that determines whether the rule should look for duplicate or unique values in the range.

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 a Range object specifying the cell range to which the formatting rule is applied.

IBorders

getBorders()

Returns an instance of IBorders which represents the borders of this conditional format.

DupeUnique

getDupeUnique()

Returns if the conditional format rule is looking for unique or duplicate values.

IFont

getFont()

Returns an instance of IFont which represents the font of this conditional format.

IInterior

getInterior()

Returns an instance of IInterior which represents the background color 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).

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.

FormatConditionType

getType()

Returns the type of this conditional format.

void

setAppliesTo(IRange value)

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

void

setDupeUnique(DupeUnique value)

Sets if the conditional format rule is looking for unique or duplicate values.

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

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

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.

String

toJson()

Generates a json string from the conditional format.

Method Details
- getAppliesTo
  
  IRange getAppliesTo()
  
  Returns a Range object specifying the cell range to which the formatting rule is applied.
- setAppliesTo
  
  void setAppliesTo(IRange value)
  
  Sets a Range object specifying the cell range to which the formatting rule is applied.
- getBorders
  
  IBorders getBorders()
  
  Returns an instance of IBorders which represents the borders of this conditional format.
- getDupeUnique
  
  DupeUnique getDupeUnique()
  
  Returns if the conditional format rule is looking for unique or duplicate values.
- setDupeUnique
  
  void setDupeUnique(DupeUnique value)
  
  Sets if the conditional format rule is looking for unique or duplicate values.
- getFont
  
  IFont getFont()
  
  Returns an instance of IFont which represents the font of this conditional format.
- getInterior
  
  IInterior getInterior()
  
  Returns an instance of IInterior which represents the background color 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).
- 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.
- 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.

Interface IUniqueValues

Method Summary

Method Details

getAppliesTo

setAppliesTo

getBorders

getDupeUnique

setDupeUnique

getFont

getInterior

getNumberFormat

setNumberFormat

getPriority

setPriority

getStopIfTrue

setStopIfTrue

getType

delete

setFirstPriority

setLastPriority

fromJson

toJson