ReportDesignerPreviewClientSideEventsBuilder.ParametersReset(String) Method

Sets the name of the JavaScript function or the entire code that will handle the ParametersReset client-side event of the Web Report Designer‘s Preview.

Namespace: DevExpress.AspNetCore.Reporting.ReportDesigner

Assembly: DevExpress.AspNetCore.Reporting.v24.1.dll

NuGet Package: DevExpress.AspNetCore.Reporting

Declaration

C#

public ReportDesignerPreviewClientSideEventsBuilder ParametersReset(
    string callback
)

VB.NET

Public Function ParametersReset(
    callback As String
) As ReportDesignerPreviewClientSideEventsBuilder

Parameters

Name	Type	Description
callback	String	The name of a JavaScript function or the entire JavaScript function code used to handle the ParametersReset event.

Returns

Type	Description
ReportDesignerPreviewClientSideEventsBuilder	A ReportDesignerPreviewClientSideEventsBuilder that can be used to further configure the Report Designer Preview Client Side Events.

Remarks

The ParametersReset event fires each time report parameter values are reset (for instance, when an end-user presses the Reset button in the Parameters panel). When implementing a handling function, use the objects passed as parameters. The first parameter passes the event sender that is the ClientReportDesigner object. The second one is an object with the following structure.

• ParametersViewModel
  A View Model for report parameters.

• Parameters
  Report parameters whose values have been reset.

The code sample below demonstrates how to use this event to automatically collapse the Parameters panel after resetting parameter values.

CSHTML

@{
    var designer = Html.DevExpress().ReportDesigner("reportDesigner1").Height("1000px")
        .Bind(Model.Report)
        .DataSources(configureDS => { foreach (var ds in Model.DataSources) { configureDS.Add(ds.Key, ds.Value); } })
        .ClientSideEvents(configure => { configure.Preview(configure => { configure.ParametersReset("previewParametersReset"); }); } );
}
@designer

JavaScript

<script type="text/javascript" id="script"> 
    function previewParametersReset(s, e) {
        var preview = s.GetPreviewModel();
        if (preview) {
            preview.tabPanel.collapsed(true);
        }
    }
</script>