FormulaExpressionConditionalFormatting Interface

Represents a conditional formatting rule that uses a formula as a formatting criteria.

Namespace: DevExpress.Spreadsheet

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

NuGet Package: DevExpress.Spreadsheet.Core

NuGet Packages: DevExpress.Spreadsheet.Core, DevExpress.WindowsDesktop.Spreadsheet.Core

Declaration

C#

public interface FormulaExpressionConditionalFormatting :
    ConditionalFormatting,
    ISupportsFormatting

VB.NET

Public Interface FormulaExpressionConditionalFormatting
    Inherits ConditionalFormatting,
             ISupportsFormatting

Related API Members

The following members return FormulaExpressionConditionalFormatting objects:

• ConditionalFormattingCollection.AddFormulaExpressionConditionalFormatting(CellRange, String)

Remarks

The conditional formatting rule specified by the FormulaExpressionConditionalFormatting object contains a formula to be evaluated. When the formula result is true, the cell is highlighted. 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.AddFormulaExpressionConditionalFormatting method) or remove (the ConditionalFormattingCollection.Remove method) the conditional format.

Example

This example demonstrates how to create the rule that uses a formula as a criterion to apply a conditional format.

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

   • A CellRange object that defines a range of cells to which the rule is applied.
   • A string value that determines a formula to evaluate.
2. Specify formatting options to be applied to cells if the condition is true, using the ISupportsFormatting.Formatting property of the FormulaExpressionConditionalFormatting object.

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

View Example

ConditionalFormatting.vb

' Create the rule to shade alternate rows without applying a new style.
Dim cfRule As FormulaExpressionConditionalFormatting = worksheet.ConditionalFormattings.AddFormulaExpressionConditionalFormatting(worksheet.Range("$A$2:$G$15"), "=MOD(ROW(),2)=1")
' Specify formatting options to be applied to cells if the condition is true.
' Set the background color to light blue.
cfRule.Formatting.Fill.BackgroundColor = Color.FromArgb(255, &HBC, &HDA, &HF7)

ConditionalFormatting.cs

// Create the rule to shade alternate rows without applying a new style.
FormulaExpressionConditionalFormatting cfRule = worksheet.ConditionalFormattings.AddFormulaExpressionConditionalFormatting(worksheet.Range["$A$2:$G$15"], "=MOD(ROW(),2)=1");
// Specify formatting options to be applied to cells if the condition is true.
// Set the background color to light blue.
cfRule.Formatting.Fill.BackgroundColor = Color.FromArgb(255, 0xBC, 0xDA, 0xF7);