'Declaration Public MustInherit Class StatFunction
'Usage Dim instance As StatFunction
public abstract class StatFunction
Xceed DataGrid for WPF v7.3 Documentation
'Declaration Public MustInherit Class StatFunction
'Usage Dim instance As StatFunction
public abstract class StatFunction
Only the statistical functions that are added to the StatFunctions collection of a DataGridCollectionView or DataGridCollectionViewSource can be used.
The values used to calculate the results of a statistical function are retrieved from its statistical context. For example, if an element that displays the results of a statistical function is contained in a group footer, the element's statistical context will be the group, and the results of the statistical function will be calculated according to the values of the data items in the group. If the same element is placed in the footers of a grid, then its statistical context is provided by a grid (through the StatContext property) and all the data items will be used to calculate the results.
The same statistical function can be used by more than one element, regardless of the statistical context. For example, if the average of a column is to be displayed in both the footers of a group and a grid, only one AverageFunction needs to be added to the StatFunctions collection.
Statistical functions that are calculated for a specific detail-level cannot be accessed by parent, child, or sibling detail-levels nor can they be accessed by a master grid and vice-versa.
With the exception of the CountFuntion, a null reference (Nothing in Visual Basic) and DBNull values will be ignored.
System.Object
Xceed.Wpf.DataGrid.Stats.StatFunction
Xceed.Wpf.DataGrid.Stats.AverageFunction
Xceed.Wpf.DataGrid.Stats.CorrelationCoefficientFunction
Xceed.Wpf.DataGrid.Stats.CovarianceFunction
Xceed.Wpf.DataGrid.Stats.CumulativeStatFunction
Xceed.Wpf.DataGrid.Stats.MedianFunction
Xceed.Wpf.DataGrid.Stats.ModeFunction
Xceed.Wpf.DataGrid.Stats.StandardDeviationFunction
Xceed.Wpf.DataGrid.Stats.VarianceFunction
| Name | Description | |
|---|---|---|
 | ResultPropertyName | Gets or sets the unique, case-sensitive property name from which the result of the function can be retrieved. |
| SourcePropertyName | Gets or sets the name of the column whose values will be used to calculate the result. |
| Name | Description | |
|---|---|---|
 | IsInitialized | Gets a value indicating whether Initialize method has been called, indicating that the types in which the values will be accumulated have been initialized. |
 | IsSealed | Gets a value indicating whether this instance is in an immutable state. |
| PrerequisiteFunctions | Gets a list of the statistical functions whose results are required by the current statistical function in order to calculate its own result. |
| RequiresAccumulation | Gets a value indicating whether the statistical function needs to accumulate its own results. |
| Name | Description | |
|---|---|---|
 | Accumulate | Accumulates the values required to calculate the result of the statistical function. |
 | CheckSealed | Checks whether this object is read-only and cannot be changed. |
| GetEquivalenceKey | Retrieves a value that represents the statistical function's unique equivalence key. |
| GetResult | Retrieves the result of the statistical function. |
| Initialize | Initializes the statistical function specifying the types in which the values will be accumulated. |
| InitializeFromInstance | Initializes the properties of the current instance of the same-type statistical function when a new instance of the same function needs to be created. |
| InitializePrerequisites | Initializes the prerequisite statistical functions defined by the PrerequisiteFunctions property. |
| IsEquivalent | Retrieves a value indicating whether a statistical function is the equivalent of the current statistical function such that both statistical functions will return the same result for the same set of values. |
| Reset | Resets the statistical function to its original state. |
| Validate | Validates the statistical function to ensure that it is able to calculate its result. |
Target Platforms: Windows 11, Windows 10, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2