CustomFunctions Class

Contains static methods to register a custom function for the Expression Editor in the Report Designer.

Namespace: DevExpress.XtraReports.Expressions

Assembly: DevExpress.XtraReports.v21.2.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#

public class CustomFunctions :
    BaseCustomFunctions

VB.NET

Public Class CustomFunctions
    Inherits BaseCustomFunctions

Remarks

The CustomFunctions class allows you to register a custom function that users can utilize in the Expression Editor for expression bindings and calculated fields.

Create a Custom Function (WinForms Report Designer)

To create a custom function, create an object that descends from the ReportCustomFunctionOperatorBase abstract class.

The following code defines a custom function in the String category:

CustomFormatFunction.cs

using DevExpress.XtraReports.Expressions;
using System;
// ...
    public class CustomFormatFunction : ReportCustomFunctionOperatorBase
    {
        public override string FunctionCategory 
            => "String";
        public override string Description 
            => "CustomFormatFunction(string format, object arg0)" +
            "\r\nConverts an arg0 value to a string based on a specified format";
        public override bool IsValidOperandCount(int count) 
            => count == 2;
        public override bool IsValidOperandType(int operandIndex, int operandCount, Type type) 
            => true;
        public override int MaxOperandCount
            => 2;
        public override int MinOperandCount
            => 2;
        public override object Evaluate(params object[] operands)
        {
            string res = String.Format(operands[0].ToString(), operands[1]);
            return res;
        }
        public override string Name 
            => "CustomFormatFunction";
        public override Type ResultType(params Type[] operands)
        {
            return typeof(string);
        }
    }

CustomFormatFunction.vb

Imports DevExpress.XtraReports.Expressions
Imports System
' ...
    Public Class CustomFormatFunction
        Inherits ReportCustomFunctionOperatorBase

        Public Overrides ReadOnly Property FunctionCategory() As String
            Get
                Return "String"
            End Get
        End Property
        Public Overrides ReadOnly Property Description() As String
            Get
                Return "CustomFormatFunction(string format, object arg0)" _
                & ControlChars.CrLf & "Converts an arg0 value to a string based on a specified format"
            End Get
        End Property
        Public Overrides Function IsValidOperandCount(ByVal count As Integer) As Boolean
            Return count = 2
        End Function
        Public Overrides Function IsValidOperandType(ByVal operandIndex As Integer,
            ByVal operandCount As Integer, ByVal type As Type) As Boolean
            Return True
        End Function
        Public Overrides ReadOnly Property MaxOperandCount() As Integer
            Get
                Return 2
            End Get
        End Property
        Public Overrides ReadOnly Property MinOperandCount() As Integer
            Get
                Return 2
            End Get
        End Property
        Public Overrides Function Evaluate(ParamArray ByVal operands() As Object) As Object
            Dim res As String = String.Format(operands(0).ToString(), operands(1))
            Return res
        End Function
        Public Overrides ReadOnly Property Name() As String
            Get
                Return "CustomFormatFunction"
            End Get
        End Property
        Public Overrides Function ResultType(ParamArray ByVal operands() As Type) As Type
            Return GetType(String)
        End Function
    End Class

Call the static CustomFunctions.Register method to register a custom function. Pass the custom function class instance as a parameter. To unregister a custom function, use the static CustomFunctions.Unregister method.

The following code registers a custom function for use in the End-User Designer:

Form1.cs

private void Form1_Load(object sender, EventArgs e)
{
// ...
    DevExpress.XtraReports.Expressions.CustomFunctions.Register(new CustomFormatFunction());
    // ...
    reportDesigner1.OpenReport(new Reports.XtraReport1());
}

Form1.vb

Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles Me.Load
' ...
    DevExpress.XtraReports.Expressions.CustomFunctions.Register(New CustomFormatFunction())
    ' ...
    reportDesigner1.OpenReport(New XtraReport1())
End Sub

The Expression Editor displays the CustomFormatFunction in the String category:

Custom functions registered in the Form constructor are available only in the Report Designer on the form. They are not available in the Visual Studio Report Designer. You can proceed without the Expression Editor and use the Property Grid editor to type a custom function in an expression.

Register a Custom Function in the Visual Studio Report Designer

Do the following to register a function for use in the Expression Editor for the Visual Studio Report Designer:

1. Create a Component class in Visual Studio.

2. Register a custom function in the component’s constructor:

   Form1.cs

   public partial class Component1 : Component
   {
       public Component1()
       {
           InitializeComponent();
           DevExpress.XtraReports.Expressions.CustomFunctions.Register(new NewLineConstant());
           DevExpress.XtraReports.Expressions.CustomFunctions.Register(new CustomFormatFunction());
       }
   
       public Component1(IContainer container)
       {
           container.Add(this);
   
           InitializeComponent();
       }
   }
   

   Form1.vb

   Public Class Component1
       Inherits System.ComponentModel.Component
       Public Sub New()
           DevExpress.XtraReports.Expressions.CustomFunctions.Register(New NewLineConstant())
           DevExpress.XtraReports.Expressions.CustomFunctions.Register(New CustomFormatFunction())
       End Sub
   End Class
   

3. Rebuild the project.

4. Open a report in the Visual Studio Report Designer.
5. Drag Component1 from the Toolbox and drop it on the report’s design surface.

Custom functions are now available for use in expressions and in the Expression Editor.

View Example: Expression Editor - How to Implement a Custom Function in a Reporting Application for ASP.NET Core

Create a Custom Function (Web)

Review the following help topics:

• Custom Functions in the Expression Editor (ASP.NET Web Forms)
• Custom Functions in the Expression Editor (ASP.NET MVC)
• Custom Functions in the Expression Editor (ASP.NET Core)
• Custom Functions in the Expression Editor (Angular)

Inheritance

Object

BaseCustomFunctions

CustomFunctions