Class
ConditionalFormattingRule

Base class for rules that evaluate cell values and apply formatting when specific conditions are met, enabling dynamic visual feedback in worksheets.

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.Model.ConditionalFormattings

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

cs-api-definition
public abstract class ConditionalFormattingRule

Inheritance: objectConditionalFormattingRule

Derived Classes: ColorScaleRuleConditionalFormattingDxfRuleDataBarRuleIconSetRule

Constructors

ConditionalFormattingRule()

Initializes a new conditional formatting rule with default priority and evaluation behavior.

Declaration

cs-api-definition
protected ConditionalFormattingRule()

Methods

AutoFail(ICellValue)

Returns a failure resolution result (0.0) regardless of the cell value, used for rules that never apply.

Declaration

cs-api-definition
[SuppressMessage("Microsoft.Usage", "CA1801:ReviewUnusedParameters", MessageId = "value")]
protected static double AutoFail(ICellValue value)

Parameters

value

ICellValue

Does not serve any purpose

Returns

double

0d

AutoSuccess(ICellValue)

Returns a successful resolution result (1.0) regardless of the cell value, used for rules that always apply.

Declaration

cs-api-definition
[SuppressMessage("Microsoft.Usage", "CA1801:ReviewUnusedParameters", MessageId = "value")]
protected static double AutoSuccess(ICellValue value)

Parameters

value

ICellValue

Does not serve any purpose

Returns

double

1d

Resolve(ICellValue)

Evaluates the cell value against the rule's condition and returns a numeric result indicating whether the condition is met (positive for match, zero for no match).

Declaration

cs-api-definition
protected virtual double Resolve(ICellValue value)

Parameters

value

ICellValue

The cell value that is resolved by the rule

Returns

double

SwapPriority(ConditionalFormattingRule)

Exchanges the evaluation priority with another rule, affecting the order in which rules are applied when multiple rules match.

Declaration

cs-api-definition
public void SwapPriority(ConditionalFormattingRule rule)

Parameters

rule

ConditionalFormattingRule