GrapeCity.Documents.Excel.IIconSetCondition

Interface IIconSetCondition

Namespace

GrapeCity.Documents.Excel

Assembly

GcDocs.Excel.dll

Represents an icon set conditional formatting rule.

public interface IIconSetCondition

Properties

AppliesTo

Returns or sets a Range object that specifies the cell range to which the formatting rule is applied.

IRange AppliesTo { get; set; }

Property Value

IRange

Custom

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

bool Custom { get; }

Property Value

bool

IconCriteria

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

IIconCriteria IconCriteria { get; }

Property Value

IIconCriteria

IconSet

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

IIconSet IconSet { get; set; }

Property Value

IIconSet

PercentileValues

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

bool PercentileValues { get; set; }

Property Value

bool

Remarks

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.

Priority

Returns or 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.

int Priority { get; set; }

Property Value

int

Remarks

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.

ReverseOrder

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

bool ReverseOrder { get; set; }

Property Value

bool

ShowIconOnly

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

bool ShowIconOnly { get; set; }

Property Value

bool

StopIfTrue

Returns a Boolean value that determines if additional formatting rules on the cell should be evaluated if the current rule evaluates to True.

bool StopIfTrue { get; }

Property Value

bool

Type

Returns the type of this conditional format.

FormatConditionType Type { get; }

Property Value

FormatConditionType

Methods

Delete()

Deletes this conditional format.

void Delete()

FromJson(string)

Generates the conditional format from the json string.

void FromJson(string json)

Parameters

json string

The json string.

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 SetFirstPriority()

SetLastPriority()

Sets the evaluation order for this conditional formatting rule so it is evaluated after all other rules on the worksheet.

void SetLastPriority()

ToJson()

Generates a json string from the conditional format.

string ToJson()

Returns

string