Tokens in Form Fields

When you are designing a form you'll often need to check the value of one field and use it to change how another field behaves, or display the value somewhere else on your form.

Default Functions and Event Handler Functions can be used in all of the field types to set and update values as a field loads and when field values change. You can use Handlebars templates to generate HTML to display field values.

Many of the form Form Fields also let you reference field values directly using tokens. This article summarises where and how tokens can be used.

Token Format

Field value tokens have the format #FIELDNAME#. FIELDNAME is the name of the field whose value you'd like to use.

For example, if you had a Confirmation Message Action field, you could create a message that said:

Hi #FIRSTNAME# #LASTNAME#, thanks for completing our form

Which, when displayed on your form would get the values entered into the FIRSTNAME and LASTNAME fields and display them in place of the tokens.

Tokens with Repeating Pages

If you set up Repeating Pages and want to get the value from one of the repeats, you need to include the number of the instance in square brackets, like this #FIELDNAME[0]#. Remember that repeating page instances are zero-based, so the first instance is 0.

So, using the example above, displaying the values from the second instance of a repeating page:

Hi #FIRSTNAME[1]# #LASTNAME[1]#, thanks for completing our form

The following tokens can be used on a repeating page to display information about the current instance:

#PAGEINSTANCE# - The current page instance (zero-based, ie the first instance is 0)
#PAGEINSTANCEDISPLAY# - The user friendly current page instance (one-based, ie the first instance is 1)
#PAGEINSTANCEMIN# - The minimum number of instances to generate (set in the forms designer)
#PAGEINSTANCEMAX# -The maximum number of instances to generate (set in the forms designer)
#PAGEINSTANCECOUNT# - The current number of instances (of this page) that have been generated

Summary of Properties

The following fields and properties can use tokens. Sometimes tokens are used to display values to users, sometimes they are used in a field's settings.

Page Titles

Page titles can use field value tokens.

Field Hints

Every field can use field value tokens in the field hint property.

Error Message Functions

Every field that supports Error Message Functions can use tokens in their custom error messages.

Fields

Alert Box

Field value tokens can be used in the alert text.

API Server Ajax

Field value tokens can be used in the request parameters.

Database Save

Field value tokens can be used to set the object label.