GrapeCity.Documents.Excel.IFormatConditions

Interface IFormatConditions

Namespace

GrapeCity.Documents.Excel

Assembly

GcDocs.Excel.dll

Represents the conditional formats associated with a range.

public interface IFormatConditions

Properties

Count

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

int Count { get; }

Property Value

int

this[int]

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

object this[int index] { get; }

Parameters

index int

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

Property Value

object

The specified conditional format.

Methods

Add(FormatConditionType, FormatConditionOperator, object, object)

Adds a new conditional format.

object Add(FormatConditionType type, FormatConditionOperator formatConditionOperator = FormatConditionOperator.Between, object formula1 = null, object formula2 = null)

Parameters

type FormatConditionType

Specifies the type for the new conditional format.

formatConditionOperator FormatConditionOperator

Specifies the operator of the conditional format.

formula1 object

Specifies the first formula of the conditional format.

formula2 object

Specifies the second formula of the conditional format.

Returns

object

The new conditional format.

AddAboveAverage()

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

IAboveAverage AddAboveAverage()

Returns

IAboveAverage

AboveAverage object.

AddColorScale(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.

IColorScale AddColorScale(ColorScaleType colorScaleType)

Parameters

colorScaleType ColorScaleType

Returns

IColorScale

ColorScale object.

AddDatabar()

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

IDataBar AddDatabar()

Returns

IDataBar

Databar object.

AddIconSetCondition()

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

IIconSetCondition AddIconSetCondition()

Returns

IIconSetCondition

IconSetCondition object.

AddTop10()

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

ITop10 AddTop10()

Returns

ITop10

Top10 object.

AddUniqueValues()

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

IUniqueValues AddUniqueValues()

Returns

IUniqueValues

UniqueValues object

Delete()

Deletes all conditional formats associated with the represented range.

void Delete()

FromJson(string)

Generates the conditional formats from the json string.

void FromJson(string json)

Parameters

json string

The json string.

ToJson()

Generates a json string from the conditional formats.

string ToJson()

Returns

string

The conditional formats json string.