CustomFunctions.Register(ICustomFunctionOperator[]) Method

Registers the specified custom functions in the Expression Editor in the End-User Report Designer.

Namespace: DevExpress.XtraReports.Expressions

Assembly: DevExpress.XtraReports.v23.1.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#

public static void Register(
    params ICustomFunctionOperator[] functionOperators
)

VB.NET

Public Shared Sub Register(
    ParamArray functionOperators As ICustomFunctionOperator()
)

Parameters

Name	Type	Description
functionOperators	ICustomFunctionOperator[]	A collection of custom functions to register.

Remarks

The Register method allows you to use the specified custom functions in expression bindings and calculated fields. The custom functions are displayed in the list of available functions in the Expression Editor.

You should call the static Register method at application startup:

CS

DevExpress.XtraReports.Expressions.CustomFunctions.Register(new CustomFormatFunction());

VB

DevExpress.XtraReports.Expressions.CustomFunctions.Register(New CustomFormatFunction())

To remove a function, so that it is not available in the Expression Editor and won’t be evaluated in expressions, use the static CustomFunctions.Unregister method.

Tip

A custom function in DevExpress Reporting is an object that descends from the ReportCustomFunctionOperatorBase abstract class. Review the following topic for more information and code examples: CustomFunctions.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Register(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#

reporting-winforms-custom-functions-in-the-expression-editor/CS/CustomFunctionForExpressionEditorExample/Form1.cs#L13

{
    DevExpress.XtraReports.Expressions.CustomFunctions.Register(new NewLineConstant());
    DevExpress.XtraReports.Expressions.CustomFunctions.Register(new CustomFormatFunction());