appLayout

The ApplicationLayout interface represents a Form's Application Layout. This is the root object for an interactive form and provides access to elements within the form.

BaseWebForm Functions

getControls mylayout.getControls( ) Returns the Controls object that gives access to all controls available to the form.
getControlsByModifier mylayout.getControlsByModifier( modifier ) Returns an array of controls in the form that have the named modifier.
getProject mylayout.getProject( ) Returns the current project for the running form
getThemePath mylayout.getThemePath( ) Returns the path of the theme currently used or null if no theme is configured.
setThemePath mylayout.setThemePath( themePath ) Changes the Theme used by the current form to the one at the specified path.
useProjectTheme mylayout.useProjectTheme( ) Change the current Form so it uses its Project's configured Theme.
isUseProjectTheme mylayout.isUseProjectTheme( ) Returns true if the form uses the project's theme.

BaseForm Functions

abort mylayout.abort( message ) Aborts execution of the current form, integration service or workflow node and rolls back the current transaction.
getAbortMessage mylayout.getAbortMessage( ) Returns the abort message after a failure has occurred.
getFields mylayout.getFields( ) Returns the Fields object that gives access to all fields available to the form.
getLanguage mylayout.getLanguage( ) Returns the language code for the user session.
setLanguage mylayout.setLanguage( language ) Sets the language code for the user session.
getResources mylayout.getResources( ) Returns the Resources object that gives access to all resources available to the form.
getTables mylayout.getTables( ) Returns the Tables object that gives access to all tables available to the form.
getTexts mylayout.getTexts( ) Returns the Texts object that gives access to all texts available to the form.
getTimezone mylayout.getTimezone( ) Returns the time zone used for the form.
setTimezone mylayout.setTimezone( timezone ) Sets the time zone for the current form, service or workflow process.

MessageContainer Functions

addErrorMessage mylayout.addErrorMessage( message [, stopProcessing ] ) Adds an error message that will be displayed to the user.
addErrorMessage mylayout.addErrorMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) Adds an error message that will be displayed to the user.
addErrorMessageText mylayout.addErrorMessageText( text [, replaceParameters ] [, stopProcessing ] ) Adds an error message that will be displayed to the user, sourced from an existing text.
addInfoMessage mylayout.addInfoMessage( message [, stopProcessing ] ) Adds an information message that will be displayed to the user.
addInfoMessageText mylayout.addInfoMessageText( text [, replaceParameters ] [, stopProcessing ] ) Adds an info message that will be displayed to the user, sourced from an existing text.
addWarningMessage mylayout.addWarningMessage( message [, stopProcessing ] ) Adds a warning message that will be displayed to the user.
addWarningMessage mylayout.addWarningMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) Adds a warning message that will be displayed to the user.
addWarningMessageText mylayout.addWarningMessageText( text [, replaceParameters ] [, stopProcessing ] ) Adds a warning message that will be displayed to the user, sourced from an existing text.
existErrorMessages mylayout.existErrorMessages( ) Returns true if undisplayed error messages exist for this element, otherwise returns false.
existInfoMessages mylayout.existInfoMessages( ) Returns true if undisplayed info messages exist for this element, otherwise returns false.
existMessages mylayout.existMessages( ) Returns true if undisplayed info, warning or error messages exist for this element, otherwise returns false.
existWarningMessages mylayout.existWarningMessages( ) Returns true if undisplayed warning messages exist for this element, otherwise returns false.

Element Functions

getElementName mylayout.getElementName( ) Returns the element name
getElementType mylayout.getElementType( ) Returns the element type