Toggle menu

Number Input

This input field supports an integer or a floating point number. Further validation can be added using the Regular Expression, Minimum/Maximum, and Validation Function properties.

The value submitted for this field is a string representation of the number.


LabelDescriptionType Name
LabelThe label for this fieldLABEL
Show LabelWhether 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 stylesheetSHOWLABEL
HintAdditional 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 informationHINT
RequiredWhether or not the field is required to have a value to pass validationREQUIRED
DefaultA default value for the field, displayed when the field is first loadedDEFAULT
PrefixAn optional prefix to add to the fieldPREFIX
SuffixAn optional suffix to add to the fieldSUFFIX
AutocompleteAdds 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 informationAUTOCOMPLETE
Error MessageThe error message that will be displayed if this field fails its validationERRMSG
Error Message FunctionA 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:
  • REQUIRED - the field is required but has been left blank
  • MAXLENGTH - the value is longer than the maximum length
  • NUMBERTYPE - the value doesn't match the required type
  • REGEX - the value doesn't match the regular expression
  • MINVAL - the value is less than the minimum
  • MAXVAL - the value is greater than the maximum
  • VALIDATIONFUNCTION - the result of a custom validation function failing (validation function can also return custom error types)
WidthThe display width of the field. The value matches a CSS class, which actually sets the widthWIDTH
SearchableWhether 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
Maximum lengthThe maximum number of characters that may be entered. Leave empty (or set to 0) if no restriction is requiredMAXLENGTH
TypeSet whether an Integer or Floating Point number should be allowed. If the entered number does not match the selected type, validation will failNUMBERTYPE
MinimumThe minimum allowed value. Leave empty if no minimum value is to be enforcedMINVAL
MaximumThe maximum allowed value. Leave empty if no maximum value is to be enforcedMAXVAL
Regular ExpressionA regular expression that will be used to validate the number. If the input number does not match this expression, the field validation will failREGEX
Validation FunctionA 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-sideVALFUNC
Default FunctionA 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 insufficientDEFFUNC
HandlersA 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 valueHANDLERS
Read OnlyDisplay the field as read onlyREADONLY
Additional Styling ModifierAn optional CSS modifier for the field. See Common Field Properties for an exampleADDITIONALSTYLINGMODIFIER
DocumentationAdd 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 exampleDOCUMENTATION

Share this page

Facebook icon Twitter icon email icon


print icon