Description

Formats a number and sets it as the value of a string variable. As with any value in field that only accepts values of type number, the number being formatted must be properly formatted as a number before being specially formatted as a string. This means that the number must not have a currency sign, thousands separator, or any decimal point other than a period. To get a number from a string (e.g., from a number that is already formatted with a currency sign or a thousands separator) use the Format String action with the Get Number From String option. When working with a price, see the Replace Price action for additional useful functionality.

Works On

This action works on variables within the flow.

Changes Selection

This action does not change the selection.

Location

The Format Number action is located in the Fuga workshop panel under the Flow actions category.

Parameters

Variable Drop-down

The variable to insert the formatted number into. The variable should be of type string.

Expression Field

(number) The number to format. This number must be properly formatted, meaning it can not include a currency sign, a thousands separator, or have a decimal point that is not a period (as with all numbers).

Digits After Decimal Point Field

(number) How many digits there should be after the decimal point in the formatted number. If the original number contained additional digits after the decimal point, the number will be rounded. 

• 2 – Default. The cents will be formatted to the second decimal point (e.g. 2.99).

Remove Trail Zeros Check-box

Specifies whether or not to remove zeros from the end of the number. 

• Unchecked – Default. Zeros at the end of the number will be left intact.
• Checked – Zeros at the end of the number will be removed (e.g. 2.90 becomes 2.9).

Thousands Separator Check-box

Specifies whether or not to format the number to include a thousands separator. 

• Unchecked – Default. The number will be formatted without a thousands separator (e.g. 1000.00).
• Checked – The number will be formatted to include a thousands separator (e.g. 1,000.00).

Decimal Point Field

(string) Specifies the character to use as a decimal mark. 

• Blank – Default. A period will be used as the decimal mark.

Currency Sign Check-box

Specifies whether or not to include a currency sign in the formatted number. 

• Unchecked – Default. The number will not include a currency sign.
• Checked – The number will include a sign.

Currency Sign Field

(string) Specifies the character to use as the currency sign. 

• Blank – Default. No currency sign will be used.

Rounding Drop-down

Specifies how to round the number. 

• Do Not Round – Default. The formatted number will not be rounded, even if there are less digits after the decimal point than the original number.
• Round To Closest Number – The formatted number will be rounded to the closest number. Any digits after the decimal point will be zero.
• Round Down – The formatted number will be rounded down. Any digits after the decimal point will be zero.
• Round Up – The formatted number will be rounded up. Any digits after the decimal point will be zero.