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.v18.2.dll

Declaration

public WebDocumentViewerClientSideEventsBuilder CustomizeParameterLookUpSource(
    string callback
)
Public Function CustomizeParameterLookUpSource(
    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 CustomizeParameterLookUpSource event.

Returns

Type Description
WebDocumentViewerClientSideEventsBuilder

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

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

  • 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 example demonstrates how to sort look-up values of the categoryName parameter based on a custom rule. Declare an array that has category names in a sequence based on the required criterion. Then, check the parameter field of the object passed as the event's second parameter to identify the required parameter. Access look-up values using the items field and sort them using a custom sorting function, which compares indexes of categories in the array. Finally, pass the result to the dataSource property to apply changes.

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

See Also