Aspose::Cells::IAboveAverage Class Referenceabstract

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. More...

Inherits Object.

Public Member Functions

virtual bool IsAboveAverage ()=0
 Gets the flag indicating whether the rule is an "above average" rule. 'true' indicates 'above average'. Default value is true. More...
 
virtual void SetAboveAverage (bool value)=0
 Sets the flag indicating whether the rule is an "above average" rule. 'true' indicates 'above average'. Default value is true. More...
 
virtual bool IsEqualAverage ()=0
 Gets 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. More...
 
virtual void SetEqualAverage (bool value)=0
 Sets 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. More...
 
virtual Aspose::Cells::Systems::Int32 GetStdDev ()=0
 Gets 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. More...
 
virtual void SetStdDev (Aspose::Cells::Systems::Int32 value)=0
 Sets 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. More...
 

Detailed Description

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.

Member Function Documentation

◆ GetStdDev()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::IAboveAverage::GetStdDev ( )
pure virtual

Gets 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()

virtual bool Aspose::Cells::IAboveAverage::IsAboveAverage ( )
pure virtual

Gets the flag indicating whether the rule is an "above average" rule. 'true' indicates 'above average'. Default value is true.

◆ IsEqualAverage()

virtual bool Aspose::Cells::IAboveAverage::IsEqualAverage ( )
pure virtual

Gets 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.

◆ SetAboveAverage()

virtual void Aspose::Cells::IAboveAverage::SetAboveAverage ( bool  value)
pure virtual

Sets the flag indicating whether the rule is an "above average" rule. 'true' indicates 'above average'. Default value is true.

◆ SetEqualAverage()

virtual void Aspose::Cells::IAboveAverage::SetEqualAverage ( bool  value)
pure virtual

Sets 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()

virtual void Aspose::Cells::IAboveAverage::SetStdDev ( Aspose::Cells::Systems::Int32  value)
pure virtual

Sets 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.