MVCxClientListBox.PerformCallback(data) Method

Sends a callback with a parameter to update the ListBox by processing the passed information on the server, in an Action specified by the ListBox’s ListBoxSettings.CallbackRouteValues property.

Declaration

PerformCallback(
    data: any,
    onSuccess?: (arg: string) => void
): void

Parameters

Name	Type	Description
data	any	An object containing any information that needs to be passed to a handling Action specified by the ListBoxSettings.CallbackRouteValues property.
onSuccess	(arg: string) => void	A client action to perform if the server round-trip completed successfully.

Remarks

Use the PerformCallback method if you need to dynamically update the ListBox by asynchronously going to the server (using AJAX-based callback technology) and performing server-side processing in the specified Action. With the PerformCallback method’s data parameter, you can pass any information collected on the client to the server for further server processing. The onSuccess parameter allows you to specify a client function that should be executed after the server round-trip completed successfully.

The PerformCallback method posts back to the server using the callback technology and is handled in an Action specified by the ListBox‘s ListBoxSettings.CallbackRouteValues property. Any data passed via the method’s data parameter can be accessed on the server as a parameter of the specified Action. So, the necessary server-side actions can be performed in the handling Action based upon the value(s) passed from the client.

For instance, you can pass values as a hash table.

Client Script Code:

JS

myListBox.PerformCallback({key1: value}, OnSuccess);

function OnSuccess() {
    ...
}

Controller Code:

C#

ActionResult MyAction(int key1){
    ...
}

The ListBox automatically updates itself (it is rendered again) after a custom callback has been sent and processed on the server.

If you need to perform actions on the client-side before callback processing, handle the MVCxClientPopupControl.BeginCallback event.