getTextAsCurrencyDecimal

The getTextAsCurrencyDecimal method returns the text from the text property of a TextBox control in currency format converted to a Decimal value.

If the text box is empty, zero (0) is returned. If the text of a TextBox control is not a valid numeric string in the locale of the user application, an exception is raised. You should therefore use this method only for a numeric text box (that is, the dataType property value of DataType_Numeric (1), DataType_SignedNumeric (2), or DataType_Currency (3)) that guarantees the text is a valid numeric. The text can be valid but incomplete (for details, see the isValid method).

When the EnhancedLocaleSupport parameter in the [JadeEnvironment] section of the JADE initialization file is not defined or it is set to false, inconsistent results could be returned to the application server when running in JADE thin client mode and there are regional overrides, as all overrides on the application server are suppressed if enhanced locale support is not enabled. By default, formatting of locale data is done on the application server, based on the locale of the corresponding presentation client.

The value of decimals property of the text box determines the number of decimal places in the returned decimal.

A numeric TextBox control expects the negative sign and decimal place characters to be in the form defined for the locale under which the user is running. This applies when accessing the text property and when the user enters data.

Setting decimal text by using the setTextFromCurrencyDecimal method converts the numeric into the appropriate string for that locale. Retrieving the Decimal value by using the getTextAsCurrencyDecimal does the reverse. You can therefore use the getTextAsCurrencyDecimal and setTextFromCurrencyDecimal methods to access decimal text so that JADE handles the locale format for you.

The position of a negative sign indicated by the locale is honored by a leading or trailing numeric in the TextBox control. However, locales that specify a negative value expressed by parentheses (for example, (123)) are treated as a leading dash symbol (-). In addition, locales that have a leading or trailing space associated with a negative sign are treated as the equivalent format without the space (for example, - 123 will be -123 and 123 - will be 123-).