Skip to main content

DxReportDesignerCallbacks.CustomizeParameterEditors Property

Specifies the JavaScript function that handles the Web Report Designer’s CustomizeParameterEditors client-side event.

Namespace: DevExpress.Blazor.Reporting

Assembly: DevExpress.Blazor.Reporting.v23.2.JSBasedControls.Common.dll

NuGet Package: DevExpress.Blazor.Reporting.JSBasedControls.Common

Declaration

[Parameter]
public string CustomizeParameterEditors { get; set; }

Property Value

Type Description
String

The name of a JavaScript function used to handle the CustomizeParameterEditors event.

Remarks

A report can let users specify parameter values and use them to create a document displayed in a Report Designer Preview. The Preview automatically selects the editor type used to edit parameter values.

Parameter Editor

The CustomizeParameterEditors event allows you to individually specify the parameter editor for each parameter.

The handler function receives two parameters - the first parameter is the client-side Report Designer (the event sender) and the second parameter is an object with the following properties and methods:

  • parameter
    An object that stores the parameter information.

  • info
    An object that stores information required to serialize a parameter editor.

The following code shows a calendar editor without the time portion:

window.ReportingDesignerCustomization = {
    //Remove time portion from the DateTime parameter editor
    onCustomizeParameterEditors: function(s, e) {
        if(e.parameter.type === "System.DateTime") {
            e.info.editor = $.extend({}, e.info.editor);
            e.info.editor.extendedOptions = $.extend(e.info.editor.extendedOptions || {}, { type: 'date' });
        }
    }
}
See Also