BootstrapClientCallbackPanel.PerformCallback(parameter) Method
Sends a callback to the server and generates the server-side BootstrapCallbackPanel.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 BootstrapCallbackPanel.Callback 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 (for instance, in the “Name = Value;” form) via the PerformCallback method’s parameter 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 BootstrapCallbackPanel.Callback event. The method’s parameter argument is passed to the BootstrapCallbackPanel.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 the necessary actions can be additionally performed on the client side before and after callback processing by using the BootstrapClientCallbackPanel.BeginCallback and BootstrapClientCallbackPanel.EndCallback client event.
Example
This example demonstrates the basic functionality of the Callback Panel.
- Initialize a new instance of the BootstrapCallbackPanel class.
- Add required controls to the
ContentCollection
array. - Use the client
BootstrapClientCallbackPanel.PerformCallback
method to initiate a callback. Handle the BootstrapCallbackPanel.Callback event to process a callback on the server side.
The image below shows the result:
protected void CallbackPanel_Callback(object sender, DevExpress.Web.CallbackEventArgsBase e) {
if(!string.IsNullOrEmpty(e.Parameter))
passedInfo.InnerText = "Passed information: \"" + e.Parameter + "\"";
}