GrapeCity.Documents.Excel.IFormatCondition

Interface IFormatCondition

Namespace

GrapeCity.Documents.Excel

Assembly

GcDocs.Excel.dll

Represents a conditional format.

public interface IFormatCondition

Properties

AppliesTo

Returns 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

DateOperator

Gets or sets the TimePeriods Date operator used in the format condition (read or write).

TimePeriods DateOperator { get; set; }

Property Value

TimePeriods

Font

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

IFont Font { get; }

Property Value

IFont

Formula1

Returns the first formula of this conditional format.

object Formula1 { get; set; }

Property Value

object

Formula2

Returns the second formula of this conditional format.

object Formula2 { get; set; }

Property Value

object

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

Operator

Returns the operator of this conditional format.

FormatConditionOperator Operator { get; set; }

Property Value

FormatConditionOperator

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 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

Text

Returns or sets a String value specifying the text used by the conditional formatting rule.

string Text { get; set; }

Property Value

string

Remarks

This property is ignored if the Type property is not set to TextString.

TextOperator

Returns or sets one of the constants of the ContainsOperator enumeration, specifying the text search performed by the conditional formatting rule.

ContainsOperator TextOperator { get; set; }

Property Value

ContainsOperator

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

the json string.