This field type is useful for adding page level or inter-field validation over and above the validation added to individual fields. Generally you should only use one of these fields per page to improve performance and to avoid duplicating validation and possible recursion.
Properties
| Label | Description | Type Name |
|---|---|---|
| Summary | A short description of what the field does, displayed in the forms designer to help identify it | SUMMARY |
| Error Message | The default error message that will be displayed if the validation fails | ERRMSG |
| Error Message Function | A function that can be used to override the default error message. You can return a different message for each error type. The message can include the value of another field can be used by adding the field's name between # characters. See Error Message Functions for more information. This field has the following error types:
| ERRMSGFUNC |
| Label | The label for this field | LABEL |
| Validation Function | A JavaScript function provides custom validation whenever a field value changes or the form is submitted. This function will be executed client-side, provided JavaScript is enabled, and repeated server-side. The function should return true for valid, false for invalid, which will then display the default error message entered above. Alternatively a map with the properties isValid and errorMessage can be returned, see below | VALFUNC |
| Validation mode | Whether this validator will be executed client-side, server-side, or both | VALMODE |
| Documentation | Add documentation to your field to help explain any complex functionality to future users. You might include information on what the field does and how it relates to other fields on the form. Notes added here are only ever visible in the Forms Designer, they can be searched for, viewed and downloaded from the action panel. See Common Field Properties for an example | DOCUMENTATION |
Last modified on 26 February 2024
Share this page
