New to Telerik Document ProcessingStart a free 30-day trial

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:

C#
public abstract class ConditionalFormattingRule

Inheritance: objectConditionalFormattingRule

Derived Classes: ColorScaleRuleConditionalFormattingDxfRuleDataBarRuleIconSetRule

Constructors

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

C#
protected ConditionalFormattingRule()

Methods

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

C#
[SuppressMessage("Microsoft.Usage", "CA1801:ReviewUnusedParameters", MessageId = "value")]
protected static double AutoFail(ICellValue value)
Parameters:valueICellValue

Does not serve any purpose

Returns:

double

0d

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

C#
[SuppressMessage("Microsoft.Usage", "CA1801:ReviewUnusedParameters", MessageId = "value")]
protected static double AutoSuccess(ICellValue value)
Parameters:valueICellValue

Does not serve any purpose

Returns:

double

1d

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

C#
protected virtual double Resolve(ICellValue value)
Parameters:valueICellValue

The cell value that is resolved by the rule

Returns:

double

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

C#
public void SwapPriority(ConditionalFormattingRule rule)
Parameters:ruleConditionalFormattingRule