RefreshOptionsAction

 
RefreshOptionsAction is used to form a AjaxMgr.refreshOptions() call definition. With this call, the options of a HTML SELECT element can be refreshed with fresh data taken from the specified data source.

See RefreshOptionsProcess

Properties

Data Source Name (dataSource) (Accepts MScript)

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

Option Node (optionNode) (Accepts MScript)

The name of the data node in the data source that will provide the text of each option.

Value Node (valueField)

The name of the data node in the data source that will provide the value of each option.

Encrypt The Value (encryptTheValue)

Flag to indicate that the value of the data node specified with Value Node property to be encrypted

Target Element Id (targetElement)

The id of the target HTML SELECT element.

Static Options Quantity (staticOptionsQty)

The number of the options on the top of the list that should be preserved while refreshing the others.

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.

CallBack Function (callbackFunc)

The Javascript function to be called after the target element is refreshed. The function receives a MultiPartAjaxResponse object as the parameter

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.refreshOptions() 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:
/* The following definition will generate

 * a Javascript function call dynamically during compilation.

 */

%vof(/myRefreshOptionsAction/jscall)

The actual AjaxMgr.refreshOptions() 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.refreshOptions() 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.