com.grapecity.documents.excel

Interface IFormatConditions

public interface IFormatConditions

Represents the conditional formats associated with a range.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	add(FormatConditionType type) Adds a new conditional format.
java.lang.Object	add(FormatConditionType type, FormatConditionOperator formatConditionOperator, java.lang.Object formula1, java.lang.Object formula2) Adds a new conditional format.
IAboveAverage	addAboveAverage() Returns a new IAboveAverage object representing a conditional formatting rule for the specified range.
IColorScale	addColorScale(ColorScaleType colorScaleType) Returns a new IColorScale object representing a conditional formatting rule that uses gradations in cell colors to indicate relative differences in the values of cells included in a selected range.
IDataBar	addDatabar() Returns a IDataBar object representing a data bar conditional formatting rule for the specified range.
IIconSetCondition	addIconSetCondition() Returns a new IIconSetCondition object which represents an icon set conditional formatting rule for the specified range.
ITop10	addTop10() Returns a ITop10 object representing a conditional formatting rule for the specified range.
IUniqueValues	addUniqueValues() Returns a new IUniqueValues object representing a conditional formatting rule for the specified range.
void	delete() Deletes all conditional formats associated with the represented range.
void	fromJson(java.lang.String json) Generates the conditional formats from the json string.
java.lang.Object	get(int index) Returns the conditional format specified by the zero-based index.
int	getCount() Returns a value that represents the number of objects in the collection.
java.lang.String	toJson() Generates a json string from the conditional formats.

Method Detail

getCount

int getCount()

Returns a value that represents the number of objects in the collection.

get

java.lang.Object get(int index)

Returns the conditional format specified by the zero-based index.

Parameters:

index - The zero-based index of the conditional format to return.

Returns:

The specified conditional format.

add

java.lang.Object add(FormatConditionType type)

Adds a new conditional format.

Parameters:

type - Specifies the type for the new conditional format.

add

java.lang.Object add(FormatConditionType type,
                     FormatConditionOperator formatConditionOperator,
                     java.lang.Object formula1,
                     java.lang.Object formula2)

Adds a new conditional format.

Parameters:

type - Specifies the type for the new conditional format.

formatConditionOperator - Specifies the operator of the conditional format.

formula1 - Specifies the first formula of the conditional format.

formula2 - Specifies the second formula of the conditional format.

Returns:

The new conditional format.

addAboveAverage

IAboveAverage addAboveAverage()

Returns a new IAboveAverage object representing a conditional formatting rule for the specified range.

Returns:

AboveAverage object

addColorScale

IColorScale addColorScale(ColorScaleType colorScaleType)

Returns a new IColorScale object representing a conditional formatting rule that uses gradations in cell colors to indicate relative differences in the values of cells included in a selected range.

Returns:

ColorScale object

addDatabar

IDataBar addDatabar()

Returns a IDataBar object representing a data bar conditional formatting rule for the specified range.

Returns:

Databar object

addIconSetCondition

IIconSetCondition addIconSetCondition()

Returns a new IIconSetCondition object which represents an icon set conditional formatting rule for the specified range.

Returns:

IconSetCondition object

addTop10

ITop10 addTop10()

Returns a ITop10 object representing a conditional formatting rule for the specified range.

Returns:

Top10 object

addUniqueValues

IUniqueValues addUniqueValues()

Returns a new IUniqueValues object representing a conditional formatting rule for the specified range.

Returns:

UniqueValues object

delete

void delete()

Deletes all conditional formats associated with the represented range.

fromJson

void fromJson(java.lang.String json)

Generates the conditional formats from the json string.

Parameters:

json - the json string

toJson

java.lang.String toJson()

Generates a json string from the conditional formats.

Returns:

the conditional formats json string