GrapeCity.Documents.Excel.ITop10

Interface ITop10

Namespace

GrapeCity.Documents.Excel

Assembly

GcDocs.Excel.dll

Represents a top ten visual of a conditional formatting rule. Applying a color to a range helps you see the value of a cell relative to other cells.

public interface ITop10

Properties

AppliesTo

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

IRange AppliesTo { get; set; }

Property Value

IRange

Borders

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

IBorders Borders { get; }

Property Value

IBorders

Font

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

IFont Font { get; }

Property Value

IFont

Interior

Returns an instance of IInterior which represents the background color of this conditional format.

IInterior Interior { get; }

Property Value

IInterior

NumberFormat

Returns or sets the number format applied to a cell if the conditional formatting rule evaluates to True (read or write object).

string NumberFormat { get; set; }

Property Value

string

Percent

Returns or sets a Boolean value, specifying if the rank is determined by a percentage value.

bool Percent { get; set; }

Property Value

bool

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.

Rank

Returns or sets an Integer value, specifying either the number or percentage of the rank value for the conditional format rule.

int Rank { get; set; }

Property Value

int

StopIfTrue

Returns or sets 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; set; }

Property Value

bool

TopBottom

Returns or sets one of the constants of the TopBottom enumeration, determining if the ranking is evaluated from the top or bottom.

TopBottom TopBottom { get; set; }

Property Value

TopBottom

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