CustomRefreshAction

 
CustomRefreshAction can be used to develop custom Ajax solutions. The Response Handler defined with this element receives the AjaxResponse object that contains the data provided by the specified data source and makes its special treatment.

This element helps to form a AjaxMgr.customRefresh() call definition.

See CustomRefreshProcess

Properties

Data Source Name (dataSource) (Accepts MScript)

The name of a Data Source Element (e.g. mor>RelDB>RelDBQueryDataSource).

Nodes To Encrypt (nodesToEncrypt) (Separated with commas, Accepts MScript)

The names of the data nodes (separated with commas) whose values to be encrypted.

Request Parameters (requestParams)

The parameters and their values. The initial value "{p1:'p1val', p2:'p2val'} ?" aims to show the definition syntax and if no update is made to it, it is ignored in the output.

When defining this property, it is important in which element the generated call definition is used. For example the this word in "{ID:this.value}" definition represents the HTML element object that the generated call definition is used in, not this action element itself.

Busy Image (busyImage)

The HTML id of a BusyImage element that exists in the page.

Response Handler (responseHandler) (Accepts MScript)

The name of the Javascript function that receives the Response from the related Ajax Service. The only parameter of the function is an AjaxResponse object.

User Data (userData)

The user data object defined with this property is passed to the response handler and the callback function.

Error Handler (errorHandler)

The name of the function to be called when an error occurs. The function receives Exception and AjaxResponse objects as the parameters.

The calling the AjaxMgr.customRefresh() function

Dynamic Call Definition
 
On the context menu that pops up when an action element is right clicked, the following options are displayed. If the option 'Copy "Dynamic Call Definition" to Clipboard' is selected, a dynamic call definition is formed and copied to the Windows clipboard.

The copied definition can later be pasted into the event properties of the elements or into the "Embedded Script" properties of the Script elements.
 
Example:
 

%vof(/myCustomRefreshAction/jscall)

The actual AjaxMgr.customRefresh() call is generated during the compiling of the page by expanding the %vof(??/jscall) definition.

Function Call

The second "Copy to clipboard" option on the context menu is used for that. When the 'Copy "Javascript Function Call" to Clipboard' option is selected, AjaxMgr.customRefresh() call definition is formed immediately with the current values of the properties and copied to the Windows clipboard.

The call definition copied to the clipboard can later be pasted into the event properties of the elements or into the "Embedded Script" properties of the Script elements.
 

Example:

Warning! In contrary to the dynamic call definition, the changes made to the properties after the function call copied, will not be effective.