Use a check box to represent a single option that may be toggled on or off.
If on (checked) the submitted value will be the value set in the "Ticked Value" property. If off (unchecked) the submitted value will be an empty string.
Properties
| Label | Description | Type Name |
|---|---|---|
| Label | The label for the checkbox | LABEL |
| Show Label | Whether to show the label for this field or not. This property adds/removes a class on the field's label element. The styling itself is controlled by the site's style sheet | SHOWLABEL |
| Hint | Additional information displayed alongside the field to assist the user. The value of another field can be used by adding the field's name between # characters. See Common Field Properties for more information | HINT |
| Ticked Value | The value that will be submitted if the checkbox is checked (on). If the checkbox is unchecked (off), an empty string will be submitted as the field's value | TICKEDVALUE |
| Default | Default value for the field. Set to true to display the checkbox as checked (on) when it is first loaded. Set to false to leave the checkbox unchecked (off) | DEFAULT |
| Error Message | The error message that will be displayed if this field fails its validation | 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 |
| Check Required | Whether the checkbox must be checked. If set to true, the validation will prevent submission of the form until the checkbox has been checked | CHECKREQUIRED |
| Searchable | Whether this field's value should be indexed by the search (the object collection if using the database save action and/or workflow process collection if starting a workflow process). This property is ignored if an External Type is specified for the form. In this case, the ability to search is determined by the searchable property of the type itself | SEARCHABLE |
| Validation Function | A JavaScript function that can be used to provide custom field validation whenever the field value changes or the form is submitted. This function will be executed client-side, provided JavaScript is enabled in the browser, and repeated server-side | VALFUNC |
| Default Function | A JavaScript function you can use to calculate the starting field value. This function is executed server-side when the field HTML is generated. See Common Field Properties for an example | DEFFUNC |
| Handlers | A JavaScript function that is executed browser-side whenever the page loads or the field value changes. See Common Field Properties for an example | HANDLERS |
| Read Only | Display the field as read only | READONLY |
| Additional Styling Modifier | An optional CSS modifier for the field. See Common Field Properties for an example | ADDITIONALSTYLINGMODIFIER |
| 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 |
Share this page
