ExpressionConditionalFormatting Interface

Represents a conditional formatting rule that uses a relational operator to determine which cells to format.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v22.2.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

public interface ExpressionConditionalFormatting :
    ConditionalFormatting,
    ISupportsFormatting

VB.NET

Public Interface ExpressionConditionalFormatting
    Inherits ConditionalFormatting,
             ISupportsFormatting

Related API Members

The following members return ExpressionConditionalFormatting objects:

• ConditionalFormattingCollection.AddExpressionConditionalFormatting(CellRange, ConditionalFormattingExpressionCondition, String)

Remarks

The conditional formatting rule specified by the ExpressionConditionalFormatting object highlights cells whose values meet the condition expressed by the relational operator. The Worksheet.ConditionalFormattings property returns the ConditionalFormattingCollection collection that stores all conditional formatting rules specified on a worksheet. Use the methods of the ConditionalFormattingCollection object to apply (the ConditionalFormattingCollection.AddExpressionConditionalFormatting method) or remove (the ConditionalFormattingCollection.Remove method) the conditional format.

Example

This example demonstrates how to create the rule that uses a relational operator as a formatting criteria.

1. To create a new conditional formatting rule represented by the ExpressionConditionalFormatting object, access the collection of conditional formats from the Worksheet.ConditionalFormattings property and call the ConditionalFormattingCollection.AddExpressionConditionalFormatting method. Pass the following parameters:

   • A CellRange object that defines a range of cells to which the rule is applied.
   • A condition specified by one of the ConditionalFormattingExpressionCondition enumeration values.
   • A string that specifies the threshold value. Notice that the string can determine a formula to evaluate the threshold.
2. Specify formatting options to be applied to cells if the condition is true, using the ISupportsFormatting.Formatting property of the ExpressionConditionalFormatting object. Set the background and font colors.

Note

Transparency is not supported in conditional formatting.

To remove the ExpressionConditionalFormatting object, use the ConditionalFormattingCollection.Remove, ConditionalFormattingCollection.RemoveAt or ConditionalFormattingCollection.Clear methods.

View Example

ConditionalFormatting.cs

// Create the rule to identify values that are above the average in cells F2 through F15.
ExpressionConditionalFormatting cfRule =
worksheet.ConditionalFormattings.AddExpressionConditionalFormatting(worksheet.Range["$F$2:$F$15"], ConditionalFormattingExpressionCondition.GreaterThan, "=AVERAGE($F$2:$F$15)");
// Specify formatting options to be applied to cells if the condition is true.
// Set the background color to yellow.
cfRule.Formatting.Fill.BackgroundColor = Color.FromArgb(255, 0xFA, 0xF7, 0xAA);
// Set the font color to red.
cfRule.Formatting.Font.Color = Color.Red;

ConditionalFormatting.vb

' Create the rule to identify values that are above the average in cells F2 through F15.
Dim cfRule As ExpressionConditionalFormatting = worksheet.ConditionalFormattings.AddExpressionConditionalFormatting(worksheet.Range("$F$2:$F$15"), ConditionalFormattingExpressionCondition.GreaterThan, "=AVERAGE($F$2:$F$15)")
' Specify formatting options to be applied to cells if the condition is true.
' Set the background color to yellow.
cfRule.Formatting.Fill.BackgroundColor = Color.FromArgb(255, &HFA, &HF7, &HAA)
' Set the font color to red.
cfRule.Formatting.Font.Color = Color.Red