Represents the "above or below average" conditional formatting rule.
The conditional formatting rule, which is specified by the AverageConditionalFormatting object, formats cells that are above or below the average for all values in the range. 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.AddAverageConditionalFormatting method) or remove (the ConditionalFormattingCollection.Remove method) the conditional format.
This example demonstrates how to apply an "above or below average" conditional formatting rule to a range of cells.
To create a new conditional formatting rule represented by the AverageConditionalFormatting object, access the collection of conditional formats from the Worksheet.ConditionalFormattings property and call the ConditionalFormattingCollection.AddAverageConditionalFormatting 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 ConditionalFormattingAverageCondition enumeration values.
If you use the overloaded method with three parameters, pass the third parameter:
- An integer value representing a number of standard deviations to be included above or below the mean in a range of cells.
Specify formatting options to be applied to cells if the condition is true using the ISupportsFormatting.Formatting property of the AverageConditionalFormatting object. Set the background color and specify the font attributes.
Transparency is not supported in conditional formatting.
ConditionalFormattingCollection conditionalFormattings = worksheet.ConditionalFormattings; // Create the rule highlighting values that are above the average in cells C2 through C15. AverageConditionalFormatting cfRule1 = conditionalFormattings.AddAverageConditionalFormatting(worksheet.Range["$C$2:$C$15"], ConditionalFormattingAverageCondition.AboveOrEqual); // Specify formatting options to be applied to cells if the condition is true. // Set the background color to yellow. cfRule1.Formatting.Fill.BackgroundColor = Color.FromArgb(255, 0xFA, 0xF7, 0xAA); // Set the font color to red. cfRule1.Formatting.Font.Color = Color.Red; // Create the rule highlighting values that are one standard deviation below the mean in cells D2 through D15. AverageConditionalFormatting cfRule2 = conditionalFormattings.AddAverageConditionalFormatting(worksheet.Range["$D$2:$D$15"], ConditionalFormattingAverageCondition.BelowOrEqual, 1); // Specify formatting options to be applied to cells if the conditions is true. // Set the background color to light-green. cfRule2.Formatting.Fill.BackgroundColor = Color.FromArgb(255, 0x9F, 0xFB, 0x69); // Set the font color to blue-violet. cfRule2.Formatting.Font.Color = Color.BlueViolet;
Related GitHub Examples
The following code snippets (auto-collected from DevExpress Examples) contain references to the AverageConditionalFormatting interface.
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.