MVCxClientTreeList.PerformCustomDataCallback(data) Method

Sends a callback with a parameter to process the passed information on the server, in an Action specified via the TreeList's TreeListSettings.CustomDataActionRouteValues property, and then return the processing result to the client, to the ASPxClientTreeList.CustomDataCallback event. This method does not update the TreeList.

Declaration

PerformCustomDataCallback(data: any): void

Parameters

Name Type Description
data any

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

Remarks

Use the PerformCustomDataCallback 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 PerformCustomDataCallback method's data parameter, you can pass any information collected on the client to the server, for further server processing.

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


myTreeList.PerformCustomDataCallback({key1: value});

Controller Code:


ActionResult MyAction(int key1){
    ...
}

The TreeList does not automatically update (re-render) itself after such a custom data callback has been sent and processed on the server.

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

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

See Also