CriteriaOperator.RegisterCustomFunction(ICustomFunctionOperator) Method

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

Namespace: DevExpress.Data.Filtering

Assembly: DevExpress.Data.v24.2.dll

NuGet Package: DevExpress.Data

Declaration

C#

public static void RegisterCustomFunction(
    ICustomFunctionOperator customFunction
)

VB.NET

Public Shared Sub RegisterCustomFunction(
    customFunction As ICustomFunctionOperator
)

Parameters

Name	Type	Description
customFunction	ICustomFunctionOperator	An ICustomFunctionOperator object specifying a custom function to register.

Remarks

To access custom functions registered via the RegisterCustomFunction and CriteriaOperator.RegisterCustomFunctions method calls, call the CriteriaOperator.GetCustomFunctions function. To search for a specific registered custom function, call the CriteriaOperator.GetCustomFunction function.

Note

The RegisterCustomFunction method throws an exception if the customFunction has already been registered.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the RegisterCustomFunction(ICustomFunctionOperator) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-create-and-register-custom-filter-editor-functions/CS/DXApplication5/CustomFunctions/NotBeginsWith.cs#L13

public static void Register() {
    CriteriaOperator.RegisterCustomFunction(instance);
}

How-to-calculate-fiscal-functions-for-date-time-data-fields/CS/Dashboard_FiscalFunctions/Program.cs#L24

UserLookAndFeel.Default.SetSkinStyle("DevExpress Style");
CriteriaOperator.RegisterCustomFunction(new GetFiscalYearFunction(1, 10));
CriteriaOperator.RegisterCustomFunction(new GetFiscalQuarterFunction(1, 10));

xaf-how-to-use-data-from-security-in-criterion/CS/CustomFunctionCriteriaOperator.Module/CurrentCompanyOidParameter.cs#L25

if (CriteriaOperator.GetCustomFunction(instance.Name) == null) {
   CriteriaOperator.RegisterCustomFunction(instance);
}

reporting-winforms-use-a-custom-function-in-query-expression/CS/SelectQueryWindowsFormsApplication/StDevOperator.cs#L10

public static void Register() {
    CriteriaOperator.RegisterCustomFunction(new StDevFunction());
}

wpf-diagram-use-custom-functions-in-shape-templates/CS/WpfApp13/MainWindow.xaml.cs#L29

public static void Register() {
    CriteriaOperator.RegisterCustomFunction(instance);
}

VB.NET

how-to-create-and-register-custom-filter-editor-functions/VB/DXApplication5/CustomFunctions/NotBeginsWith.vb#L10

Public Shared Sub Register()
    CriteriaOperator.RegisterCustomFunction(instance)
End Sub

How-to-calculate-fiscal-functions-for-date-time-data-fields/VB/Dashboard_FiscalFunctions/Program.vb#L24

UserLookAndFeel.Default.SetSkinStyle("DevExpress Style")
CriteriaOperator.RegisterCustomFunction(New GetFiscalYearFunction(1, 10))
CriteriaOperator.RegisterCustomFunction(New GetFiscalQuarterFunction(1, 10))

xaf-how-to-use-data-from-security-in-criterion/VB/CustomFunctionCriteriaOperator.Module/CurrentCompanyOidParameter.vb#L27

If CriteriaOperator.GetCustomFunction(instance.Name) Is Nothing Then
   CriteriaOperator.RegisterCustomFunction(instance)
End If

reporting-winforms-use-a-custom-function-in-query-expression/VB/SelectQueryWindowsFormsApplication/StDevOperator.vb#L11

Public Shared Sub Register()
    CriteriaOperator.RegisterCustomFunction(New StDevOperator())
End Sub

wpf-diagram-use-custom-functions-in-shape-templates/VB/WpfApp13/MainWindow.xaml.vb#L31

Public Shared Sub Register()
    CriteriaOperator.RegisterCustomFunction(instance)
End Sub