printFloatExpression() Operation

Syntax

set aString = aFloat.printFloatExpression(aFormat, aLocale?)

Semantics

printFloatExpression() initializes a String object from a Float using the given format expression. The format expression is a string with placeholders for number variables. The syntax is described in Number Formatting.

Substitutables

aFloat

Can be any variable or object attribute having the type Float.

aFormat

Can be any variable or object attribute having the type String. The pattern syntax is described in Number Formatting.

aLocale

Optional variable or object attribute having the type Basic Components.Basic Behavior.NumbersLocale.

This parameter can be used to define the following properties:

Locale Setting	Description	Example
negativeSign	Characters used to signify negative values.	`-`
positiveSign	Characters used to signify positive values.	`+`
thousandsSeparator	Characters used to separate units of thousand.	`,`
decimalPoint	Characters used to separate the decimal places.	`.`
currencySymbol	Characters used to indicate the currency of the value.	`$`

Default values are given by the system locales.

Examples

NONE

set aString = aFloat.printFloatExpression("999.99");

Formatting examples can be found in Number Formatting.

Related Pages:

Number Formatting