Where does ConditionalFormatting live in the IronXL API?

ConditionalFormatting is a class in the IronXL.Formatting namespace, shipped in IronXL.dll. It groups conditional formatting rules and is passed to AddConditionalFormatting on a worksheet's ConditionalFormatting accessor.

How do you manage several conditional formatting rules together in C#?

Use a ConditionalFormatting set: AddRule appends a ConditionalFormattingRule, GetRule and SetRule access a rule by index, and NumberOfRules reports the total. GetFormattingRanges returns the ranges the rules apply to.

Class ConditionalFormatting

The ConditionalFormatting class encapsulates all Settings of Conditional Formatting.

Inheritance

System.Object

ConditionalFormatting

Namespace: IronXL.Formatting

Assembly: IronXL.dll

Syntax

public class ConditionalFormatting : Object

ConditionalFormatting is the rule set a developer hands to a worksheet to highlight cells by criteria. It bundles one or more ConditionalFormattingRule objects together with the ranges they cover, so a group of related rules travels and applies as a single unit rather than rule by rule.

The object is passed to AddConditionalFormatting on a worksheet's ConditionalFormatting accessor, which attaches its rules to the sheet. Build up the set first, then attach it, and the rules take effect when the workbook is saved or evaluated. NumberOfRules reports how many rules the set holds. AddRule appends a ConditionalFormattingRule, GetRule and SetRule read and replace a rule by its integer index, and GetFormattingRanges returns the ranges the rules apply to. Use it when several rules belong to the same formatting pass and should be managed as one collection. For a single quick rule, the worksheet accessor's CreateConditionalFormattingRule and AddConditionalFormatting shortcut is usually enough.

ConditionalFormattingRule rule =
    sheet.ConditionalFormatting.CreateConditionalFormattingRule(ComparisonOperator.LessThan, "8");
sheet.ConditionalFormatting.AddConditionalFormatting("A1:A10", rule);

The conditional formatting how-to shows the add, retrieve, and remove flow, and the conditional formatting example applies a rule to a range.

Properties

NumberOfRules

Gets the number of rules.

Declaration

public int NumberOfRules { get; }

Property Value

Type	Description
System.Int32	The number of rules.

Methods

AddRule(ConditionalFormattingRule)

Add a Conditional Formatting rule. Excel allows to create up to 3 Conditional Formatting rules.

Declaration

public void AddRule(ConditionalFormattingRule cfRule)

Parameters

Type	Name	Description
ConditionalFormattingRule	cfRule	The Conditional Formatting rule

GetFormattingRanges()

Returns the list of ranges to apply formatting.

Declaration

public List<RangeAddress> GetFormattingRanges()

Returns

Type	Description
System.Collections.Generic.List<RangeAddress>	List of range addresses.

GetRule(Int32)

Returns the Conditional Formatting rule at specified position.

Declaration

public ConditionalFormattingRule GetRule(int idx)

Parameters

Type	Name	Description
System.Int32	idx	Position of the rule.

Returns

Type	Description
ConditionalFormattingRule	The Conditional Formatting rule at specified position.

SetRule(Int32, ConditionalFormattingRule)

Replaces an existing Conditional Formatting rule at position idx. Excel allows to create up to 3 Conditional Formatting rules. This method can be useful to modify existing Conditional Formatting rules.

Declaration

public void SetRule(int idx, ConditionalFormattingRule cfRule)

Parameters

Type	Name	Description
System.Int32	idx	Position of the rule. Should be between 0 and 2.
ConditionalFormattingRule	cfRule	Conditional Formatting rule