This is a version of the 'Text Input' field type that does not store its value. It will not generate a property within the object type definition when the form is published and cannot be used to store a value automatically. Neither will it 'remember' any value entered into it in a multi-page form.
Properties
| Property | Description | Type Name |
|---|---|---|
| Label | The label for this field | 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 stylesheet | SHOWLABEL |
| Hint | Additional information displayed alongside the field to assist the user in completing it. The value of another field can be used by adding the field's name between # characters. See Common Field Properties for more information | HINT |
| Required | Whether or not the field is required to have a value to pass validation | REQUIRED |
| Default | A default value for the field | DEFAULT |
| Prefix | An optional prefix to add to the field | PREFIX |
| Suffix | An optional suffix to add to the field | SUFFIX |
| Placeholder | Any value entered into this property is used as an HTML 5 placeholder. This is a value that will appear in the field but will be cleared when a user enters something in the field. Unlike a default value, it will not be submitted as a value for the field. If a default value is supplied, the placeholder will not be seen unless the user clears the default value | PLACEHOLDER |
| Autocomplete | Adds a HTML autocomplete attribute to the field, which may prompt the browser to suggest relevant values for the filed, based on past or preconfigured (in the browser) values for the field. See Common Field Properties for more information | AUTOCOMPLETE |
| 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 |
| Width | The display width of the text input field. This property adds a CSS class to the field which is used by the site's stylesheet to change the field width | WIDTH |
| Maximum length | The maximum number of characters that can be entered. Leave empty (or set to 0) if you don't want to apply a limit | MAXLENGTH |
| Pattern | Pre-defined regular expressions that will be used to validate the text. If the input text does not match this expression, the field validation will fail | PREDEFREGEX |
| Regular Expression | A regular expression that will be used to validate the text. If the input text does not match this expression, the field validation will fail. Use the editor provided to construct and test the regular expression | REGEX |
| 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 that can be used to calculate the default field value. This function is executed server-side when the field HTML is generated and is useful when the DEFAULT property is insufficient | DEFFUNC |
| Handlers | A JavaScript function that is executed client-side whenever the page loads, or the field value changes. This function is useful for modifying the values of other fields based on an entered value | HANDLERS |
| Read Only | Display the field as read only | READONLY |
| Show | Determines when the guidance text should be output. The following options are available: Always - the value will always be output. Form - the value will only be output when the page HTML is being rendered on the site (in 'standard' mode). Summary (Email) - the value will only be output when the page HTML is rendered in read-only mode, without controls, for example in emails. | SHOW |
| 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 |
Last modified on 26 February 2024
Share this page
