ConditionalFormattingCollection.AddSpecialConditionalFormatting(CellRange, ConditionalFormattingSpecialCondition) Method

Applies the conditional formatting rule that formats cells which contain the specified values (unique or duplicate values, formula errors, etc.).

Namespace: DevExpress.Spreadsheet

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

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

SpecialConditionalFormatting AddSpecialConditionalFormatting(
    CellRange range,
    ConditionalFormattingSpecialCondition condition
)

VB.NET

Function AddSpecialConditionalFormatting(
    range As CellRange,
    condition As ConditionalFormattingSpecialCondition
) As SpecialConditionalFormatting

Parameters

Name	Type	Description
range	CellRange	A CellRange object that specifies a range of cells to which the conditional formatting rule is applied.
condition	ConditionalFormattingSpecialCondition	One of the ConditionalFormattingSpecialCondition enumeration values.

Returns

Type	Description
SpecialConditionalFormatting	A SpecialConditionalFormatting object that represents the specified conditional format.

Example

This example demonstrates how to specify the rule that highlights unique or duplicate values, formula errors, etc.

1. To create a new conditional formatting rule represented by the SpecialConditionalFormatting object, access the collection of conditional formats from the Worksheet.ConditionalFormattings property and call the ConditionalFormattingCollection.AddSpecialConditionalFormatting 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 ConditionalFormattingSpecialCondition enumeration values.
2. Specify formatting options to be applied to cells if the condition is true, using the ISupportsFormatting.Formatting property of the SpecialConditionalFormatting object.

Note

Transparency is not supported in conditional formatting.

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

View Example

ConditionalFormatting.cs

// Create the rule to identify unique values in cells A2 through A15. 
SpecialConditionalFormatting cfRule = worksheet.ConditionalFormattings.AddSpecialConditionalFormatting(worksheet.Range["$A$2:$A$15"], ConditionalFormattingSpecialCondition.ContainUniqueValue);
// 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);

ConditionalFormatting.vb

' Create the rule to identify unique values in cells A2 through A15. 
Dim cfRule As SpecialConditionalFormatting = worksheet.ConditionalFormattings.AddSpecialConditionalFormatting(worksheet.Range("$A$2:$A$15"), ConditionalFormattingSpecialCondition.ContainUniqueValue)
' 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)

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the AddSpecialConditionalFormatting(CellRange, ConditionalFormattingSpecialCondition) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

wpf-spreadsheet-how-to-apply-conditional-formatting-to-a-range-of-cells/CS/ConditionalFormatting_WPF_Examples/SpreadsheetActions/ConditionalFormatting.cs#L153

// Create the rule to identify unique values in cells A2 through A15.
SpecialConditionalFormatting cfRule = worksheet.ConditionalFormattings.AddSpecialConditionalFormatting(worksheet.Range["$A$2:$A$15"], ConditionalFormattingSpecialCondition.ContainUniqueValue);
// Specify formatting options to be applied to cells if the condition is true.

spreadsheet-document-api-apply-conditional-formatting-to-cell-range/CS/ConditionalFormatting_Example/SpreadsheetActions/ConditionalFormatting.cs#L156

// Create the rule to identify unique values in cells A2 through A15.
SpecialConditionalFormatting cfRule = worksheet.ConditionalFormattings.AddSpecialConditionalFormatting(worksheet["$A$2:$A$15"], ConditionalFormattingSpecialCondition.ContainUniqueValue);
// Specify formatting options to be applied to cells if the condition is true.

winforms-spreadsheet-apply-conditional-formatting-to-a-range-of-cells/CS/SpreadsheetControl/SpreadsheetActions/ConditionalFormatting.cs#L154

// Create the rule to identify unique values in cells A2 through A15.
SpecialConditionalFormatting cfRule = worksheet.ConditionalFormattings.AddSpecialConditionalFormatting(worksheet.Range["$A$2:$A$15"], ConditionalFormattingSpecialCondition.ContainUniqueValue);
// Specify formatting options to be applied to cells if the condition is true.

VB.NET

wpf-spreadsheet-how-to-apply-conditional-formatting-to-a-range-of-cells/VB/ConditionalFormatting_WPF_Examples/SpreadsheetActions/ConditionalFormatting.vb#L135

' Create the rule to identify unique values in cells A2 through A15.
Dim cfRule As SpecialConditionalFormatting = worksheet.ConditionalFormattings.AddSpecialConditionalFormatting(worksheet.Range("$A$2:$A$15"), ConditionalFormattingSpecialCondition.ContainUniqueValue)
' Specify formatting options to be applied to cells if the condition is true.

spreadsheet-document-api-apply-conditional-formatting-to-cell-range/VB/ConditionalFormatting_Example/SpreadsheetActions/ConditionalFormatting.vb#L144

' Create the rule to identify unique values in cells A2 through A15.
Dim cfRule As SpecialConditionalFormatting = worksheet.ConditionalFormattings.AddSpecialConditionalFormatting(worksheet("$A$2:$A$15"), ConditionalFormattingSpecialCondition.ContainUniqueValue)
' Specify formatting options to be applied to cells if the condition is true.

winforms-spreadsheet-apply-conditional-formatting-to-a-range-of-cells/VB/SpreadsheetControl/SpreadsheetActions/ConditionalFormatting.vb#L137

' Create the rule to identify unique values in cells A2 through A15.
Dim cfRule As SpecialConditionalFormatting = worksheet.ConditionalFormattings.AddSpecialConditionalFormatting(worksheet.Range("$A$2:$A$15"), ConditionalFormattingSpecialCondition.ContainUniqueValue)
' Specify formatting options to be applied to cells if the condition is true.