Register Custom Report Parameter Types

• Aug 10, 2018

You can register custom report parameter types in the WPF End-User Report Designer using the static ParameterTypeRegistrator class’s methods as shown below.

C#

using DevExpress.Xpf.Reports.UserDesigner;
// ...

public enum Gender { Male, Female }

// Replace the display name for an already registered type.
ParameterTypeRegistrator.Register<int>("My Integer Display Name");

// Register a new enum type.
ParameterTypeRegistrator.Register<Gender>();

// Register an image parameter type with the display name.
ParameterTypeRegistrator.Register(typeof(byte[]), "Image");

VB.NET

Imports DevExpress.Xpf.Reports.UserDesigner
' ...

Public Enum Gender
    Male
    Female
End Enum

' Replace the display name for an already registered type.
ParameterTypeRegistrator.Register(Of Integer)("My Integer Display Name")

' Register a new enum type.
ParameterTypeRegistrator.Register(Of Gender)()

' Register an image parameter type with the display name.
ParameterTypeRegistrator.Register(GetType(Byte()), "Image")

The registered parameter types are available for all Report Designer instances opened in the application.

Tip

When previewing a report with custom type parameters, the standard editors are automatically displayed in the Parameters panel to request parameter values.

See Provide Custom Editors for Report Parameters to learn how to implement custom parameter editors.