Software Customisation Reference Manual

Name	Result	Purpose
Checkrefs	BOOLEAN	By default, all references in a Form definition are checked when a form is displayed. Checking can be switched off, which may be recommended if performance problems are experienced.
CurrentDocument()	FORM	This method returns the current Document of the application framework as a FORM object. If there is no current document then the returned form has value Unset.
DefaultFormat()	FORMAT	Query the system default format object for use by typed text gadgets. If none defined then returns an Unset local variable. The returned format object is a copy, so changing it will not affect the system default format. However you can apply it to variables e.g !text=!myVar.String(!!fmsys.defaultFormat())
DefaultFormLayout( )	STRING	query the current default form layout mode
DocsAtMaxScreen(BOOLEAN)	NO RESULT	Sets default placement position for document forms to be towards the maximum (rightmost) of the screen. Useful for wide screen ad twin screen devices.
FMINFO()	ARRAY OF STRINGS	Returns array of all FMINFO strings.
HelpFileAlias()	STRING	returns the current help file’s alias.
Interrupt()	BOOLEAN	Set to TRUE if the interrupt gadget has been selected.
LoadForm(STRING formname)	FORM	Allows force loading of a form definition and/or the ability to get a reference to a form object by name. If the form exists then a reference to the form object is returned. If it doesn’t exist, then an attempt is made to force load its definition. If this fails then an unset form reference is returned.
Main()	FORM	Query the current main form
NoPMLUIbars()	BOOLEAN	Query the status of the main application window’s MenuBar and DialogBar. It returns true if the PML UI bars are switched off. In this case, PML Addins should not add or modify main Menus or Toolbars.
OKCurfnView(!viewtype is STRING)	BOOLEAN	Queries whether graphical views of the specified view type are displayed. Graphical view types supported are: ‘G2D’; ‘G3D’; ‘ANY’ and any view subtype is implied.
OKCurfnView(!viewtype is STRING, subtype is STRING )	BOOLEAN	Queries whether graphical views of the specified view type and subtype are displayed. Graphical view types supported are: ‘G2D’; ‘G3D’; ‘ANY’. View subtypes supported are: ‘ANY’ and for G2D: ‘NORMAL’ (Draw); ‘PLOT’; ‘ISOSPOOL’ G3D: ‘NORMAL’ (Design)
Progress( )	REAL	Get the current Integer value in percent shown by the progress bar, in the range 0 to 100. Zero means the bars is invisible
ProgressText( )	STRING	Query the current setting of the progress bars qualifier text.
Refresh()	NO RESULT	Refresh all VIEW gadgets
SetDefaultFormat(!!fmt is FORMAT)	NO RESULT	Provide a default global format object to be used if no specific format is defined for any typed text field. Once only call, users cannot change it. !!fmt must be a global variable.
SetDefaultFormLayout(STRING)	NONE	Set the default form layout mode to 'VARCHARS' or 'FIXCHARS'.
SetHelpFileAlias(alias is string)	NONE	establishes the application help file from its alias.
SetInterrupt(GADGET)	NO RESULT	Sets the Gadget which will interrupt macro or function processing.
SetMain(FORM)	FORM	Sets the main form for an Application.
SetProgress( !percent)	NO RESULT	Set the Integer value in percent to be displayed in the progress bar. Values will be forced into the range 0 to 100. Resultant value of 0 will cause the bar to become invisible.
SetProgressText(!text is STRING )	NO RESULT	Set the progress bar's qualifier text to the specified string.
SetStatusText(!text is STRING)	NO RESULT	The text in the lower left corner of the AppWindow’s status bar is set to the specified string. This field supports application status information and you should note that some parts of the system also write to the status field, for example command prompts and cursor picking, so any information you write should be considered as transient.
Splashscreen(BOOLEAN)	NO RESULT	Removes the display of a splash screen after an abnormal exit.
StatusText( )	STRING	Returns the current AppWindow's status bar text string.