Function Signature Parameters
The following parameters are passed to the various functions described in this document.
| Name | Description |
|---|---|
| context | Contains any context variables generated by the site framework |
| currentValue | The current value of the field, this may be undefined |
| defaultErrorMessage | The default error message a field may display |
| defaultPage | Used in navigation functions. The page that would be navigated to if this function wasn't present |
| defaultPageInstance | Used in navigation functions. The page instance that would be navigated to if this function wasn't present |
| defaultValue | The default value of the field. This is normally the value of the DEFAULT property |
| errorType | The type of error thrown by a field failing validation. See Error Message Functions for the full list of types |
| eventName | Either "CHANGE" (the value has changed), "NEWPAGEINIT" (the page is loading for the first time) or "PAGEINIT" (the page is loading) |
| fieldName | The name of the field firing the event |
| helper | The form helper library |
| mode | Whether the form is being rendered in: |
| optionData | The options in list-type fields |
| pageInstance | The instance number of the page, this will be 0 for a new page, 1 for a page that exists in the form session data (ie a page that has been submitted) |
| pageName | The name of the page about to be displayed |
| processor | The skeleton processor |
| props | Contains any properties |
| sessionData | The current session data storing (amongst other things) the values of fields submitted so far |
| valid | true if the field passed validation, false if it failed |
| value | The value of the field |
Last modified on 19 March 2024
