GrapeCity.Documents.Excel.IColorScale

Interface IColorScale

Namespace

GrapeCity.Documents.Excel

Assembly

GcDocs.Excel.dll

Represents a color scale conditional formatting rule.

public interface IColorScale

Properties

AppliesTo

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

IRange AppliesTo { get; set; }

Property Value

IRange

ColorScaleCriteria

Returns a ColorScaleCriteria object, which is a collection of individual ColorScaleCriterion objects. The ColorScaleCriterion object specifies the type, value, and color of threshold criteria used in the color scale conditional format (read-only).

IColorScaleCriteria ColorScaleCriteria { get; }

Property Value

IColorScaleCriteria

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.

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