NumberToString()

Format

NumberToString(Number [,Decimals] [,TrimZeros])

Returns

Converts the supplied number into a string.

Inputs

Number: The number to be converted into a string.
Behaviour: Required
Dimension: Collection, SingleValue, MultiCollection
Valid data types: Decimal, Integer

Decimals: The number of decimal places to use in the conversion. Specify a value from 0 to 15. Default: 2
Behaviour: Optional
Dimension: Collection, SingleValue
Valid data types: Decimal, String

TrimZeros: By default, any trailing zeroes after the decimal place are trimmed. Override this behaviour by passing False (or zero).
Behaviour: Optional
Dimension: Collection, SingleValue
Valid data types: Boolean, Decimal, Integer, String

How to format data types

Examples

Expression: NumberToString(56.3)
Result: 56.3

Expression: NumberToString(56.324)
Result: 56.32

Expression: NumberToString(56.324, 2)
Result: 56.32

Expression: NumberToString(56.324, 1)
Result: 56.3

Expression: NumberToString(56.324, 0)
Result: 56

Expression: NumberToString(56.324, 4, True)
Result: 56.324

Expression: NumberToString(56.324, 4, False)
Result: 56.3240

Expression: NumberToString({TagABC.PV})
Result: The numeric value of the tag TagABC.PV converted to a string.

Release History

  • NumberToString() 4.6.5
    • Changed Number parameter to support MultiCollection values.
  • NumberToString() 4.0
    • Initial version

Comments are closed