How to: Register an Additional Type of XtraReport Parameter

• Jul 05, 2019
• 2 minutes to read

This example demonstrates how to extend the list of parameter types available in the Report Designer.

Important

The functionality described here is for WinForms only. Currently, the ASPxReportDesigner control used in ASP.NET applications does not support custom parameter types.

In this topic, it is assumed that you have an XAF application that uses the Reports V2 Module, and you have created one or more reports (see Reports V2 Module Overview).

Access an XtraReportDataTypeProvider instance using the XafReportDataTypeProvider parameter passed to the static ReportDesignExtensionManager.CustomizeReportExtension event. Then, handle the XtraReportDataTypeProvider.CustomAddParameterTypes event and add custom types to the Dictionary list passed to the event handler. Additionally, handle the XtraReportDataTypeProvider.GetCustomEditableDataTypes event and add custom types to the Types array passed to the event handler. The following snippet illustrates how to add the Gender enumeration type.

C#

using DevExpress.ExpressApp.ReportsV2;
// ...
static class Program {
    static void Main() {
        ReportDesignExtensionManager.CustomizeReportExtension += ReportDesignExtensionManager_CustomizeReportExtension;
        // ...
    }
    static void ReportDesignExtensionManager_CustomizeReportExtension(object sender, CustomizeReportExtensionEventArgs e) {
        e.XafReportDataTypeProvider.CustomAddParameterTypes += XafReportDataTypeProvider_CustomAddParameterTypes;
        e.XafReportDataTypeProvider.GetCustomEditableDataTypes += XafReportDataTypeProvider_GetCustomEditableDataTypes;
    }
    static void XafReportDataTypeProvider_CustomAddParameterTypes(object sender, AddCustomParameterTypesEventArgs e) {
        e.Dictionary.Add(typeof(Gender), "Gender");
    }
    static void XafReportDataTypeProvider_GetCustomEditableDataTypes(object sender, GetCustomEditableDataTypesEventArgs e) {
        List<Type> types = new List<Type>(e.Types);
        types.Add(typeof(Gender));
        e.Types = types.ToArray();
    }
    // ...
}
public enum Gender { Male, Female}

VB.NET

Imports DevExpress.ExpressApp.ReportsV2
' ...
Friend NotInheritable Class Program
    Private Sub New()
    End Sub
    Shared Sub Main()
        AddHandler ReportDesignExtensionManager.CustomizeReportExtension, AddressOf ReportDesignExtensionManager_CustomizeReportExtension
        ' ...
    End Sub
    Private Shared Sub ReportDesignExtensionManager_CustomizeReportExtension(ByVal sender As Object, ByVal e As CustomizeReportExtensionEventArgs)
        AddHandler e.XafReportDataTypeProvider.CustomAddParameterTypes, AddressOf XafReportDataTypeProvider_CustomAddParameterTypes
        AddHandler e.XafReportDataTypeProvider.GetCustomEditableDataTypes, AddressOf XafReportDataTypeProvider_GetCustomEditableDataTypes
    End Sub
    Private Shared Sub XafReportDataTypeProvider_CustomAddParameterTypes(ByVal sender As Object, ByVal e As AddCustomParameterTypesEventArgs)
        e.Dictionary.Add(GetType(Gender), "Gender")
    End Sub
    Private Shared Sub XafReportDataTypeProvider_GetCustomEditableDataTypes(ByVal sender As Object, ByVal e As GetCustomEditableDataTypesEventArgs)
        Dim types As New List(Of Type)(e.Types)
        types.Add(GetType(Gender))
        e.Types = types.ToArray()
    End Sub
    ' ...
End Class
Public Enum Gender
    Male
    Female
End Enum

The result is demonstrated in the image below.