REFRESH

Syntax

Command
Mandatory parameter
Optional parameter
Mandatory keyword
Optional keyword

REFRESH ([<Help screen>])

Description

Repaints the current form, using the current field values. If specified, also the implemented help screen will be shown.

Diagram

Returned value type

None

Parameters

Parameter	Description
<Help screen>	If the help screen parameter is used, the set help page will be opened in a new tab. Allowed values are: An expression giving the name of an AMT created help screen. An expression giving the filename of a plain text file or HTML file located in the Help folder of the application. Filepaths relative to the Help folder may be used. The Help folder location is set in the Basepaths screen of the ControlCenter. An expression giving the absolute filepath and filename of a plain text file or HTML file. See the examples below for an example of each option.

Parameter

Description

<Help screen>

If the help screen parameter is used, the set help page will be opened in a new tab.
Allowed values are:

An expression giving the name of an AMT created help screen.
An expression giving the filename of a plain text file or HTML file located in the Help folder of the application.
Filepaths relative to the Help folder may be used.
The Help folder location is set in the Basepaths screen of the ControlCenter.
An expression giving the absolute filepath and filename of a plain text file or HTML file.

See the examples below for an example of each option.

Remarks

This statement does not call any routine that is implemented in the form, though the DISPLAY_MAIN is always called if you call a screen without the REFRESH.

Overview of some properties of sme, smex, exit, refresh and sme + error.

	SME	SMEX	EXIT	REFRESH()	SME + ERROR
System item error	Not changed	Set to true	Not changed	Set to true	Already true
Ends current routine	No	Yes	Yes	No	No
Repaints screen	No	No	No	Yes	No
Perform display main	Yes	No	Yes	No	No

Form calling priority

The commands ‘gotoform’, ‘refresh’, ‘closeform’ and ‘showpopup’, all execute the remaining display/process main logic, so it is possible that multiple instances of these commands are encountered before the transaction has ended.

The table below explains which command takes priority and is ultimately executed.

1 Indicates that this command overrules the previously encountered command, which is now not executed.

2 Indicates that the previous command takes precedence over this command, so it is the previous command only that is executed.

3 Indicates that both commands will be executed.

This command	Previous command
This command		gotoform (form)	gotoform (BYE)	refresh ()	closeform ()	showpopup (popup form)	gotoform ( form, , NEW)
gotoform (form)	1	1	1	1	1	3
gotoform (BYE)	1	-	1	1	1	1
refresh ()	1	1	-	1	1	3
closeform ()	1	1	1	-	1	3
showpopup (popup form)	1	1	1	1	1	1
gotoform ( form, , NEW)	3	2	3	3	1	3

The optional help screen request is not relevant for the priority of the commands. If the command is executed, any help screen also requested will be displayed.

Examples

refresh ()

HelpScreen1 := 'Help1'
refresh (HelpScreen1)

refresh ('TXT\Help2.txt')

refresh ('D:\Files\Helpscreens\Help3.html')

Return to

Commands