All docs
V20.1
20.1
19.2
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

CriteriaOperator.RegisterCustomAggregate(ICustomAggregate) Method

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

Namespace: DevExpress.Data.Filtering

Assembly: DevExpress.Data.v20.1.dll

Declaration

public static void RegisterCustomAggregate(
    ICustomAggregate customAggregate
)
Public Shared Sub RegisterCustomAggregate(
    customAggregate As ICustomAggregate
)

Parameters

Name Type Description
customAggregate ICustomAggregate

A custom aggregate function to register.

Remarks

To access custom aggregate functions registered via the RegisterCustomAggregate and CriteriaOperator.RegisterCustomAggregates method calls, call the CriteriaOperator.GetCustomAggregates function. To search for a specific registered custom function, call the CriteriaOperator.GetCustomAggregate function.

NOTE
  • The RegisterCustomAggregate method throws an exception if the customAggregate has already been registered.
  • The customAggregate 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.
See Also