RangeExtensions.Average(CellRange, Boolean, Boolean) Method

Returns the average of numerical values in the current cell range.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v24.1.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

public static double Average(
    this CellRange range,
    bool ignoreHiddenRows,
    bool ignoreHiddenColumns
)

VB.NET

<ExtensionAttribute>
Public Shared Function Average(
    range As CellRange,
    ignoreHiddenRows As Boolean,
    ignoreHiddenColumns As Boolean
) As Double

Parameters

Name	Type	Description
range	CellRange	A cell range for which the average is calculated.
ignoreHiddenRows	Boolean	true to exclude hidden rows from calculation; otherwise, false.
ignoreHiddenColumns	Boolean	true to exclude hidden columns from calculation; otherwise, false.

Returns

Type	Description
Double	The average value. If cells are empty or don’t contain numeric values, this method returns 0.

Remarks

Use the following extension methods to summarize data in a cell range. You can call these methods in the same way as instance methods of the CellRange object.

Method	Description
RangeExtensions.Average	Returns the average of numerical values in a cell range.
RangeExtensions.Count	Returns the number of cells that contain data.
RangeExtensions.NumericalCount	Returns the number of cells that contain numerical data.
RangeExtensions.Sum	Returns the sum of numerical values in a cell range.
RangeExtensions.Max	Returns the maximum numerical value in a cell range.
RangeExtensions.Min	Returns the minimum numerical value in a cell range.

The following code example shows how to obtain summary values for selected cells in the Spreadsheet control.

C#

CellRange selectedCells = spreadsheetControl1.Selection;
double average = selectedCells.Average(true, true);
double sum = selectedCells.Sum(true, true);
double count = selectedCells.Count(true, true);
double numCount = selectedCells.NumericalCount(true, true);

VB.NET

Dim selectedCells As CellRange = spreadsheetControl1.Selection
Dim average As Double = selectedCells.Average(True, True)
Dim sum As Double = selectedCells.Sum(True, True)
Dim count As Double = selectedCells.Count(True, True)
Dim numCount As Double = selectedCells.NumericalCount(True, True)