Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

XL.ConditionalFormating.AddAboveAverageRule

Adds a conditional formatting rule that highlights cells that are above or below the average for all values in the range.

Component Version macOS Windows Linux Server iOS SDK
XL 14.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "XL.ConditionalFormating.AddAboveAverageRule"; bookRef; ConditionalFormattingRef; ConditionalFormatRef { ; aboveAverage; equalAverage; stdDev; stopIfTrue } )   More

Parameters

Parameter Description Example Flags
bookRef The reference to the workbook. Please use XL.LoadBook to load a file. $ref
ConditionalFormattingRef The reference number for the conditional formatting. $ConditionalFormatting
ConditionalFormatRef The reference number for the conditional format.
The conditional format used for highlighting cells, use the XL.Book.AddConditionalFormat for adding conditional formats.		 $ConditionalFormat
aboveAverage True for [above average] rule, false for [below average] rule.
Default is true.		 Optional
equalAverage True for inclusive of the average itself, false for exclusive of that value, valid only for [above average] rule.
Default is false.		 Optional
stdDev The number of standard deviations to include above or below the average, valid only for [above average] rule. Optional
stopIfTrue If true, no rules with lower priority may be applied over this rule, when this rule is true. Optional

Result

Returns OK or error.

Description

Adds a conditional formatting rule that highlights cells that are above or below the average for all values in the range.

See also

Created 30th March 2024, last changed 31st March 2024


XL.ConditionalFormating.Add3ColorScaleRule - XL.ConditionalFormating.AddOpNumRule