Forms 2.0 - Money
caution
This page is preliminary and subject to change as Forms 2.0 continues to be developed.
Displays a currency amount with configurable formatting. The user inputs the amount while the currency symbol is shown separately.
Adding a Money field
Drag the Money tile from the field palette onto the Canvas - see Build for more on adding and arranging fields in general.
Currency modes
The Mode parameter controls how currencies are configured for the field, and which other parameters are shown:
| Mode | Behavior |
|---|---|
| Single Currency | The field is locked to one currency, chosen with the Currency parameter. |
| Multiple Currencies | The user picks from a restricted list of currencies, set with Allowed Currencies. |
| Global | The user can pick from all available currencies, optionally reordered with Preferred Currencies or narrowed with Exclude Currencies. |
Parameters
Only Money-specific parameters are listed below. See Common Field Settings for the settings shared with other field types.
| Field | Description |
|---|---|
| Mode | See Currency modes above. |
| Currency | Only shown in Single Currency mode. The currency to use for the field. |
| Allowed Currencies | Only shown in Multiple Currencies mode. Comma-delimited list of currency codes to restrict which currencies are selectable (for example USD,EUR,GBP), shown in the order specified. Supports Tokens. |
| Preferred Currencies | Only shown in Global mode. Comma-delimited list of currency codes to show at the top of the dropdown; the rest are listed alphabetically. |
| Exclude Currencies | Only shown in Global mode. Comma-delimited list of currency codes to exclude from the dropdown. |
| Initial Currency | Only shown in Multiple Currencies or Global mode. The currency code selected by default. In Multiple Currencies mode, it must be one of the Allowed Currencies. Supports Tokens. |
| Initial Amount | The amount the field loads with initially. Supports Tokens. |
| Number Format | Which language's formatting conventions (thousands and decimal separators) to use: Browser Language, Portal/System Language, or a Specific Language. |
| Specific Language | Only shown when Number Format is Specific Language. The language/country to format numbers with. Supports Tokens. |
| Precision | The number of decimal places to display. Defaults to 2. Supports Tokens. |
| Currency Symbol | How the currency is displayed: Symbol (for example $, CA$, RON), Narrow Symbol (for example $, $, L), or Three Letter Code (for example USD, CAD, RON). |
| Root CSS Classes | One or more CSS class names, separated by spaces, applied to the field's root element only. Supports Tokens. |
| Custom Attributes | Name/value pairs inserted as HTML attributes on the field's <input> tag, for use by JavaScript or CSS. Supports Tokens. |
Common settings that apply to Money
A Money field supports these Common Field Settings:
- General (Label, Name, and Hint)
- Active
- Visibility settings
- Enabled settings
- Field Automations - Value and On Change (Money does not support On Click)
- Field Validators
Tokens
A Money field returns these tokens, referenced using the field's Name - for example, if the field's Name is Price:
| Token | Description |
|---|---|
[Price] | The formatted currency amount with its symbol (for example $1,000). |
[Price:Amount] | The raw decimal amount, unformatted (for example 1000.00). |
[Price:Currency] | The three-letter currency code (for example USD). |