fApplication interface

FOM Reference > Application > fApplication interface

The top level FOM object, providing access to all system level properties and methods. This object is always available and can be accessed using the global property "application".

jsDebugFlags enumeration

Determines which debug info is output.

The jsDebugFlags enumeration has the following constants of type int.

JSDEBUGFLAG_ALLINFO = 1

This flag enables all debug information to be output.

JSDEBUGFLAG_SETTERS = 2

This flag enables just the property setter debug information to be output.

JSDEBUGFLAG_GETTERS = 4

This flag enables just the property getter debug information to be output.

JSDEBUGFLAG_METHODS = 8

This flag enables just the methods debug information to be output.

JSDEBUGFLAG_INIT_CREATE_DESTROY = 16

This flag enables debug information for object init, create and destroy to be output.

JSDEBUGFLAG_ENUMERATE = 32

This flag enables debug information for enumeration to be output.

activeTemplate attribute

The current active template. This property is also available as the global variable "template".

activeTemplate
Access	read-only
Returns	fTemplate

arrays attribute

An array containing all system arrays, also known as Perl's @ variables.

arrays
Access	read-only
Returns	fArray

build attribute

The current build number.

build
Access	read-only
Returns	int

defaultDocumentPath attribute

The default location APP will use to locate template files.

defaultDocumentPath
Access	read-only
Returns	fPath

domImplementation attribute

The DOM implementation.

domImplementation
Access	read-only
Returns	fxDOMImplementation

environment attribute

An array containing all system environment variables.

environment
Access	read-only
Returns	fStringArray

features attribute

An array of the APP Feature variables, containing properties for all the components available in this version of APP.

features
Access	read-only
Returns	fIntArray

fonts attribute

An array containing all fonts currently available to APP.

fonts
Access	read-only
Returns	fFont

hashes attribute

An array containing all system hashes, also known as Perl's % variables.

hashes
Access	read-only
Returns	fArray

installPath attribute

The path this version of APP is currently installed into.

installPath
Access	read-only
Returns	fPath

isBlackbox attribute

If true, this is the Blackbox version of APP.

isBlackbox
Access	read-only
Returns	boolean

isOCX attribute

If true, this is the OCX version of APP.

isOCX
Access	read-only
Returns	boolean

isUnicode attribute

If true, this is the Unicode version of APP, Otherwise, it is the Standard version.

isUnicode
Access	read-only
Returns	boolean

jsDebugFlag attribute

Flag for outputting debug information for FOM. Output will be directed to the LOG_JSDBG log. Values for this property can be found in the fApplication.jsDebugFlags constants.

jsDebugFlag
Access	read-write
Returns	int

logs attribute

An array of the 16 APP logs.

logs
Access	read-only
Returns	fArray

variables attribute

An array containing all scalar system variables, also known as Perl's $ variables.

variables
Access	read-only
Returns	fStringArray

version attribute

The current version number.

version
Access	read-only
Returns	String

versionMajor attribute

The current major version number.

versionMajor
Access	read-only
Returns	int

versionMinor attribute

The current minor version number.

versionMinor
Access	read-only
Returns	int

versionPatch attribute

The current patch number.

versionPatch
Access	read-only
Returns	String

alert method

Macro: boxit

Opens a message box containing the specified text.

alerttext
Parameters	Stringtext The text string to display.
Returns	void. None.

calculateHash method

Calculates a integer hash value for the specified string.

calculateHashstringlowercase
Parameters	Stringstring The string to hash. booleanlowercase If true, the string will be converted to lower case before hashing.
Returns	float. The resulting integer hash value.

loadJS method

Macro: runjs

Loads an external JS file and runs the contents.

loadJSfilename
Parameters	fPathfilename The path of the file containing the script.
Returns	void. None.

loadTemplate method

Macro: read / trd, edit / ted

Loads a new template file, and makes it the new active template.

loadTemplatefilenamerunAutoexecloadPFIstartPage
Parameters	fPathfilename The path of the template file to load. booleanrunAutoexec If true, run any autoexec script present in the template. booleanloadPFI If true, load any saved page format information present in the template. intstartPage The page number to select when the template has loaded.
Returns	fTemplate. The fTemplate object for the new template.

runMacro method

Runs the specified macro.

runMacromacrowait
Parameters	Stringmacro The macro to run, including any parameters. booleanwait If true, the call does not return until the macro has completed (or is interrupted).
Returns	void. None.

status method

Writes a message to the text mode status bar.

statustext
Parameters	Stringtext The text string to display.
Returns	void. None.

zipOpen method

Creates a new fZip object.

zipOpenareapathopenModedefaultCompression
Parameters	Stringarea The name of the area to use when accessing the zip file. fPathpath The path of the zip file to open. intopenMode The mode to use when opening the zip file. This defaults to fZip.OPEN_CREATE. Values are in fZip-OpenModes. intdefaultCompression The default compression level to use for all files. Values are in fZip-CompressionLevels.
Returns	fZip. A new fZip object.