WebDocumentViewerClientSideEventsBuilder.ParametersSubmitted(String) Method

Sets the name of the JavaScript function or the entire code that will handle the ParametersSubmitted client-side event of the Web Document Viewer.

Namespace: DevExpress.AspNetCore.Reporting.WebDocumentViewer

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

NuGet Package: DevExpress.AspNetCore.Reporting

Declaration

C#

public WebDocumentViewerClientSideEventsBuilder ParametersSubmitted(
    string callback
)

VB.NET

Public Function ParametersSubmitted(
    callback As String
) As WebDocumentViewerClientSideEventsBuilder

Parameters

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

Returns

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

Remarks

The ParametersSubmitted event fires when all parameter values have been entered in the Parameters panel and the Submit button has been pressed. 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 and their submitted values.

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

CSHTML

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

JavaScript

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