+The TCallbackClientScript class provides corresponding methods that can be
+executed on the client-side (i.e. the browser client that is viewing
+the page) during a callback response.
+For a complete list of available client side methods, consult the
+
+The available methods includes setting/clicking input elements, changing Css +styles, hiding/showing elements, and adding visual effects to elements on the +page. The client-side methods can be access through the CallbackClient +property available in TPage. +
+ ++For example, to hide "$myTextBox" element during callback response, do: +
++TCallbackClientSide is used to specify client-side callback request options and client-side event handlers. +Each active control that inherits from TActiveBaseCallbackControl has a ClientSide property. +The ClientSide property is an instance TCallbackClientSide containing the actual options and event handlers +that are used by the client-side when that control is making a callback request. +The following example demonstrates the toggling of a "loading" indicator when the client-side is making a callback request. +
+ ++The following client side events are executing in order if the callback +request and response are send and received successfuly. +
+ ++* Note that theses 2 events are not fired correctly by Opera. To make + them work in this browser, Prado will fire them just after onPreDispatch. +
+ +
+In a general way, onUninitialized, onLoading, onLoaded and onInteractive events
+are not implemented consistently in all browsers. When cross browser compatibility is
+needed, it is best to avoid use them.
+
The OnSuccess and OnFailure events are raised when the
+response is returned. A successful request/response will raise
+OnSuccess event otherwise OnFailure will be raised.
+
+The following properties can be used to change the way the callback request is performed. +
+ ++TCallbackOptions allows a common set of callback client-side options +to be attached to one or more active controls. +This can be useful if a lot of active controls on the same page are sharing the same callback client-side options. +Instead of specifying the same set of options again and again inside each control, these can be written once +inside a TCallbackOptions; this TCallbackOptions can be then attached to each control using the +ActiveControl.CallbackOptions property. For a full list of assignable properties, please check the +TCallbackClientSide documentation. +
+ ++The typical scenario of use for a TCallbackOptions is a page where a lot of active controls needs to +pause the user interaction with a "Please wait" style message until callback completion. +First create a single TCallbackOptions control, assign it an ID and the the needed properties: +
+ ++Then, share this set of options to one or more active controls; each control will follow them: +
+ ++ Choose an action from the list and click the button; the server-side php code will get the selected value and + force the execution of some clientside js code in the callback response. +
+ +| Checkbox 1: | +|
| Label 1: | +|
| TextBox 1: | +
| +A callback button with attached client side options: + |
+ |
| +A callback button logging all callback events (5 seconds delay): + |
+ |
| +A callback with RequestTimeout="3000" (3 seconds). Since the callback will take 5 seconds to complete, the clientside will timeout. +This will cause a "missing page state" error; note that the callback is not considered failed, since no +connection error has occured. + |
+ |
| +A callback button with attached client side options: + |
+ |
| +Same example as before, but this time interacting with another Prado control: + |
+ |
| +The same TCallbackOptions can be shared among different controls, even of different types: + |
+ |