ASPxClientGridView.GetValuesOnCustomCallback(args, onCallback) Method

Sends a callback to the server and generates the server-side ASPxGridView.CustomDataCallback event.

Declaration

GetValuesOnCustomCallback(
    args: string,
    onCallback: ASPxClientGridViewValuesCallback
): void

Parameters

Name	Type	Description
args	string	A string value that is any information that needs to be sent to the server-side ASPxGridView.CustomDataCallback event.
onCallback	ASPxClientGridViewValuesCallback	A ASPxClientGridViewValuesCallback object that is 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 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 GetValuesOnCustomCallback method’s args parameter.

The GetValuesOnCustomCallback method posts back to the server using the callback technology and generates a server-side ASPxGridView.CustomDataCallback event. The method’s args argument is passed to the ASPxGridView.CustomDataCallback event’s handler as the ASPxGridCustomCallbackEventArgs.Parameters 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.

After the callback is processed in the ASPxGridView.CustomDataCallback event’s handler, the resulting information can be passed back to the client side’s function specified by the onCallback parameter. This information is specified by the event’s ASPxGridCustomDataCallbackEventArgs.Result property.

For an example, see Templates | Cell in the ASPxGridView’s main demo.