RefreshAreasAction

 
RefreshAreasAction is used to form a AjaxMgr.refreshAreas() call definition. With this call, the content of a TargetArea or a SourceArea element can be refreshed with a new content supplied by a SourceArea or a RefreshableArea element.

Note that AjaxMgr.refreshAreas() call can refresh the contents of one or more areas in one go.

See Areas
See RefreshAreasProcess

Properties

Source Areas (sourceAreas) (Separated with commas, Accepts MScript)

The name of a SourceArea or a RefreshableArea element including the name of the page at the front in /source-page-name.area-name form. If more than one area needs to be refreshed, the area name must be separated with commas. The source areas can be selected using the "RefreshableArea,SourceArea List" dialog. To select multiple areas use CTRL key.

Target Area Ids (targetAreas) (Separated with commas)

The HTML ids of the target areas ("TargetArea or RefreshableArea") separated with commas. The areas can be selected using the "RefreshableArea,TargetArea List" dialog. To select multiple areas use CTRL key.

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 blocks are 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.

Origin Node (originNode)

The DOM Node object that originates this request. This property should be supplied only if the call to be made from a DOM node that was fetched with a AjaxMgr.refreshAreas() method call.

The calling the AjaxMgr.refreshAreas() 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(/myRefreshAreasAction/jscall)

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