ConnectionProviderSql.RegisterCustomAggregates(ICollection<ICustomAggregateFormattable>) Method

Registers custom aggregate functions to use in any CriteriaOperator-based criteria in your application.

Namespace: DevExpress.Xpo.DB

Assembly: DevExpress.Data.v22.2.dll

NuGet Package: DevExpress.Data

Declaration

C#

public void RegisterCustomAggregates(
    ICollection<ICustomAggregateFormattable> customAggregates
)

VB.NET

Public Sub RegisterCustomAggregates(
    customAggregates As ICollection(Of ICustomAggregateFormattable)
)

Parameters

Name	Type	Description
customAggregates	ICollection<ICustomAggregateFormattable>	A collection of custom aggregate functions to register.

Remarks

To search for a specific registered custom aggregate function, call the CriteriaOperator.GetCustomAggregate function.

Note

• The RegisterCustomAggregates method throws an exception if one of the customAggregates has already been registered.
• Each of the customAggregates must have a unique Name property value. If you use standard aggregate names (Min, Max, Sum, Avg, Single, Exists, and Count), an exception is raised.