MVCxClientSpreadsheet.PerformCallback(data) Method

Sends a callback with a parameter to update the Spreadsheet by processing the passed information on the server, in an Action specified via the SpreadsheetSettings.CustomActionRouteValues property.


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


Name Type Description
data any

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

onSuccess (arg: string) => void

A client action to perform if the server round-trip completed successfully.


Use the PerformCallback method if you need to dynamically update the Spreadsheet by asynchronously going to the server (using AJAX-based callback technology) and performing server-side processing in the specified Action. Via 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 SpreadsheetSettings.CustomActionRouteValues 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:

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

function OnSuccess() {

Controller Code:

ActionResult MyAction(int key1){

Note that a round-trip initiated by the PerformCallback method updates only the Spreadsheet document and does not update other Spreadsheet parts, such as ribbon elements.

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

See Also