Aspose::Cells::AboveAverage class

AboveAverage class

Describe the AboveAverage conditional formatting rule. This conditional formatting rule highlights cells that are above or below the average for all values in the range.

class AboveAverage

Methods

MethodDescription
AboveAverage()Default constructor.
AboveAverage(AboveAverage_Impl* impl)Constructs from an implementation object.
AboveAverage(const AboveAverage& src)Copy constructor.
GetStdDev()Get or set the number of standard deviations to include above or below the average in the conditional formatting rule. The input value must between 0 and 3 (include 0 and 3). Setting this value to 0 means stdDev is not set. The default value is 0.
IsAboveAverage()Get or set the flag indicating whether the rule is an “above average” rule. ’true’ indicates ‘above average’. Default value is true.
IsEqualAverage()Get or set the flag indicating whether the ‘aboveAverage’ and ‘belowAverage’ criteria is inclusive of the average itself, or exclusive of that value. ’true’ indicates to include the average value in the criteria. Default value is false.
IsNull() constChecks whether the implementation object is nullptr.
explicit operator bool() constoperator bool()
operator=(const AboveAverage& src)operator=
SetIsAboveAverage(bool value)Get or set the flag indicating whether the rule is an “above average” rule. ’true’ indicates ‘above average’. Default value is true.
SetIsEqualAverage(bool value)Get or set the flag indicating whether the ‘aboveAverage’ and ‘belowAverage’ criteria is inclusive of the average itself, or exclusive of that value. ’true’ indicates to include the average value in the criteria. Default value is false.
SetStdDev(int32_t value)Get or set the number of standard deviations to include above or below the average in the conditional formatting rule. The input value must between 0 and 3 (include 0 and 3). Setting this value to 0 means stdDev is not set. The default value is 0.
~AboveAverage()Destructor.

Fields

FieldDescription
_implThe implementation object.

See Also