TdxSpreadSheetConditionalFormattingRuleAboveOrBelowAverage Class

An “Above or Below Average“ conditional formatting rule.

Declaration

TdxSpreadSheetConditionalFormattingRuleAboveOrBelowAverage = class(
    TdxSpreadSheetConditionalFormattingRuleStyleBased
)

Remarks

This rule applies custom formatting to all cells within one or more specific cell ranges, provided that values within the affected cells are above or below the average for all cell values within these ranges.

The TdxSpreadSheetConditionalFormattingRuleAboveOrBelowAverage class provides the following members that allow you to:

Specify or modify one or more cell ranges affected by the rule (Areas);
Specify the cell value comparison operator and standard deviation multiplier for calculating the rule’s formatting condition (ComparisonOperator and StandardDeviationLevel);
Specify the cell style settings applied to the cells for which the rule’s formatting condition is met (Style);
Set the rule’s evaluation priority (Index);
Determine if the rule allows other rules with lower precedence to affect the same cells if its formatting condition is met (StopIfTrue);
Copy the rule between cells and/or cell ranges (Clone).

To create an “Above or Below Average” conditional formatting rule, you can:

Call a conditional formatting controller’s overloaded Add procedure (TdxSpreadSheetCustomConditionalFormatting.Add or TcxDataControllerConditionalFormatting.Add) and pass the rule’s class-reference (TdxSpreadSheetConditionalFormattingRuleAboveOrBelowAverage) as the ARuleClass parameter;
Call the Create constructor and pass the target conditional formatting controller as the AOwner parameter.

The conditional formatting controller’s Rules property provides access to individual rules. To expose an “Above or Below Average” rule’s type-specific members, cast the rule to the TdxSpreadSheetConditionalFormattingRuleAboveOrBelowAverage class.