WebDocumentViewerClientSideEventsBuilder.CustomizeParameterLookUpSource(String) Method

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

Namespace: DevExpress.AspNetCore.Reporting.WebDocumentViewer

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

NuGet Package: DevExpress.AspNetCore.Reporting

Declaration

C#

public WebDocumentViewerClientSideEventsBuilder CustomizeParameterLookUpSource(
    string callback
)

VB.NET

Public Function CustomizeParameterLookUpSource(
    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 CustomizeParameterLookUpSource event.

Returns

Type	Description
WebDocumentViewerClientSideEventsBuilder	A WebDocumentViewerClientSideEventsBuilder object that can be used to further configure the Document Viewer client side events.

Remarks

The CustomizeParameterLookUpSource event occurs each time a look-up editor is created for a report parameter. When implementing a handler 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.

• parameter
  An object that stores information about a parameter.

• items
  A collection of look-up parameter values.

• dataSource
  The data source that provides look-up values for the parameter editor.

The following code selects the first item in the lookup value list and prevents the user from submitting an empty value.

CSHTML

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

JavaScript

function onCustomizeParameterLookUpSource(s, e) {  
    var parametersModel = s.GetParametersModel();  
    if (e.parameter.name == "YourParameterNameHere" && e.items.length > 0) {  
        parametersModel[e.parameter.name](e.items[0].value);  
    }  
}