How to format a number input using FormatNumber()

This article explains what the FormatNumber() function is and provide examples of how it can be used with the binding syntax in smart templates.

What is the FormatNumber() function?

FormatNumber() is a function that formats numbers. This function is only applicable to number or currency objects, these can either originate from a number question in the response form, from a number based on a schema field in a data source, or from a value of type number or currency in an external system using an App Connector or Data Connector.

FormatNumber() logic

FormatNumber() function examples

In the examples below the form field 'Amount' is used. This is a dropdown field that is linked to the Price column of the Products data source:

FormatNumber() function examples using standard numeric format strings

Currency (C or c)

In the examples below the 'DocumentLanguage' in the User Profile set to "en-US".

Exponential (E or e)

For exponential notation, the default value of the precision specifier (number of decimal digits) is 6.
You can add a number behind the E (e.g. "2") to change the value of the precision specifier.

Fixed-Point (F or f)

Fixed-Point returns integral and decimal digits with an optional negative sign.
You can add a number behind the E (e.g. "1") to change the value of the precision specifier.

General (G or g)

General returns the more compact of either fixed-point or scientific notation.
You can add a number behind the G (e.g. "4") to change the value of the precision specifier.

Number (N or n)

Number returns integral and decimal digits, group separators, and a decimal separator with an optional negative sign.
You can add a number behind the N (e.g. "1" or "3") to change the value of the precision specifier.

Percentage (P or p)

Percentage returns a number multiplied by 100 and displayed with a percent symbol.

Note: in these examples "Form.Amount.Price" is replaced by 'Form.Percentage.Value', and "HostSystem.Amount" by "HostSystem.Percentage".

FormatNumber() function examples using custom numeric format strings

Zero placeholder (0)

Replaces a zero with the corresponding digit if one is present, otherwise a zero appears in the result string.

Digit placeholder (#)

Digit placeholder replaces the "#" symbol with the corresponding digit if one is present, otherwise, no digit appears in the result string.
Note that no digit appears in the result string if the corresponding digit in the input string is a non-significant 0. For example, 0003 ("####") will return 3.

Decimal point (.)

Decimal point determines the location of the decimal separator in the result string.

Group separator and Number scaling (,)

Serves as both a group separator and a number scaling specifier. As a group separator, it inserts a localized group separator character between each group. As a number scaling specifier, it divides a number by 1000 for each comma specified.

Group separator specifier

Number separator specifier

Percentage placeholder (%)

Percentage placeholder multiplies a number by 100 and inserts a localized percentage symbol in the result string.

Note: in these examples "Form.Amount.Price" is replaced by "Form.Percentage.Value".

Per mille placeholder (‰)

Per mille placeholder multiplies a number by 1000 and inserts a localized per mille symbol in the result string.

Note: in these examples "Form.Amount.Price" is replaced by "Form.Permille.Value".

Escape character (\)

Escape character causes the next character to be interpreted as a literal rather than as a custom format specifier.

Literal string delimiter (string)

Literal string delimiter indicates that the enclosed characters should be copied to the result string unchanged.

Note: in these examples 'Form.Amount.Price' is replaced by "Form.Angle.Value".

Section separator (;)

Section separator defines sections with separate format strings for positive, negative, and zero numbers.

All other characters

All other characters: the character is copied to the result string unchanged.

Note: in this example "Form.Amount.Price" is replaced by "Form.Angle.Value".