Class
ConditionalFormatting

Conditional formatting applied to one or more cell ranges, dynamically styling cells based on a formatting rule.

Definition

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

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

cs-api-definition
public class ConditionalFormatting

Inheritance: objectConditionalFormatting

Constructors

ConditionalFormatting(ConditionalFormattingRule)

Initializes a new conditional formatting instance with the specified rule.

Declaration

cs-api-definition
public ConditionalFormatting(ConditionalFormattingRule rule)

Parameters

rule

ConditionalFormattingRule

Properties

CellRanges

Read-only collection of cell ranges to which this conditional formatting is applied.

Declaration

cs-api-definition
public ReadOnlyCollection<CellRange> CellRanges { get; }

Property Value

ReadOnlyCollection<CellRange>

Rule

Rule that determines which cells receive conditional formatting and what styling is applied.

Declaration

cs-api-definition
public ConditionalFormattingRule Rule { get; }

Property Value

ConditionalFormattingRule

Worksheet

Worksheet to which this conditional formatting is applied; throws InvalidOperationException if accessed before the formatting is applied to a cell selection.

Declaration

cs-api-definition
public Worksheet Worksheet { get; }

Property Value

Worksheet

Methods

Resolve(CellIndex)

Evaluates the conditional formatting rule for the specified cell and returns a numeric result indicating formatting status.

Declaration

cs-api-definition
public double Resolve(CellIndex index)

Parameters

index

CellIndex

The index on which the formatting is applied.

Returns

double

UpdateRule(ConditionalFormattingRule)

Replaces the current rule with a new rule and invalidates the worksheet layout with undo support.

Declaration

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

Parameters

rule

ConditionalFormattingRule

The new rule that is applied.