WebDocumentViewerClientSideEventsBuilder.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 Document Viewer.

Namespace: DevExpress.AspNetCore.Reporting.WebDocumentViewer

Assembly: DevExpress.AspNetCore.Reporting.v18.2.dll

Declaration

public WebDocumentViewerClientSideEventsBuilder ParametersReset(
    string callback
)
Public Function ParametersReset(
    callback As String
) As WebDocumentViewerClientSideEventsBuilder

Parameters

Type Name Description
String callback

The name of a JavaScript function or the entire JavaScript function code used to handle the ParametersReset event.

Returns

Type Description
WebDocumentViewerClientSideEventsBuilder

A WebDocumentViewerClientSideEventsBuilder that can be used to further configure the Document Viewer Client Side Events.

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 ClientDocumentViewer 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.

@{
    var documentViewer = Html.DevExpress().WebDocumentViewer("webDocumentViewer1")
        .Height("1000px")
        .Bind(Model.Report)
        .ClientSideEvents(configure => { configure.ParametersReset("parametersReset"); });;
}
@documentViewer

See Also