The requested page is not available for the requested platform. You are viewing the content for Default platform.

MVCxClientGridView.GetValuesOnCustomCallback(data, onCallback) Method

Sends a callback with a parameter to process the passed information on the server, in an Action specified via the GridView's GridSettingsBase.CustomDataActionRouteValues property, and then process the returned result in the specified client function. This method does not update the GridView.

Declaration

GetValuesOnCustomCallback(data: any, onCallback: ASPxClientGridViewValuesCallback): void

Parameters

Name Type Description
data any

An object containing any information that needs to be passed to a handling Action specified via the GridSettingsBase.CustomDataActionRouteValues property.

onCallback ASPxClientGridViewValuesCallback

A ASPxClientGridViewValuesCallback object that represents the JavaScript function which receives the information on the client side.

Remarks

Use the GetValuesOnCustomCallback method if you need to asynchronously go to the server (using AJAX-based callback technology) and perform server-side processing in the specified Action. Via the GetValuesOnCustomCallback method's data parameter, you can pass any information collected on the client to the server, for further server processing.

The GetValuesOnCustomCallback method posts back to the server using the callback technology and is handled in an Action specified by the GridView's GridSettingsBase.CustomDataActionRouteValues 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:


myGridView.PerformCustomDataCallback({key1: value});

Controller Code:


ActionResult MyAction(int key1){
    ...
}

The GridView does not automatically update (re-render) itself after such a custom data callback has been sent and processed on the server. After the callback is processed in the specified Action, the resulting information can be passed back to the client side's function specified by the onCallback parameter.

If you need to perform a custom callback to the server that updates the GridView, you can send this callback via the MVCxClientGridView.PerformCallback client method and handle it in an Action specified via the GridSettingsBase.CustomActionRouteValues property.

If you need to perform actions on the client-side before and after callback processing, handle the MVCxClientGridView.BeginCallback and ASPxClientGridView.EndCallback events.

See Also