A newer version of this page is available. Switch to the current version.

ASPxClientSpreadsheet.PerformCallback(parameter) Method

Sends a callback to the server and generates the server-side ASPxSpreadsheet.Callback event, passing it the specified argument.

Declaration

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

Parameters

Name Type Description
parameter string

A string value that represents any information that needs to be sent to the server-side event.

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 asynchronously go to the server and perform some server-side processing using AJAX-based callback technology. You can pass the required information which can be collected on the client side as a string of arguments via the PerformCallback method's args parameter. 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 generates a server-side ASPxSpreadsheet.Callback event. The method's args argument is passed to the ASPxSpreadsheet.Callback event's handler as the CallbackEventArgsBase.Parameter property. So, the necessary server-side actions can be performed in the event's handler based upon the values of the arguments which can be obtained by parsing the passed information string.

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.

See Also