setLocaleNumericOptions

setLocaleNumericOptions(decimalSeparator:  String;
                        thousandSeparator: String;
                        currencySymbol:    String): Boolean;

The setLocaleNumericOptions method of the JadeReportWriterReport class sets the format for number or currency fields to be used when running the report. The method overrides default number and currency settings specified on the System Formats dialog, the Report Formats dialog, and the Field Properties dialog for number and currency fields.

The parameters for the setLocaleNumericOptions method are listed in the following table.

Parameter Description
decimalSeparator A string with a maximum of three characters that is used to separate decimal part of a number from the rest.
thousandSeparator A string with a maximum of three characters that is used as the thousands separator.
currencySymbol A string with a maximum of five characters that is used as the currency symbol.

If a parameter has an invalid value (for example, a string has too many characters), the method returns false and default formats are used.

Overriding does not take place for fields where the report or field format value is null. For example, if the thousands separator for a number field is set to null in a report, calling the setLocaleNumericOptions method with a thousandSeparator parameter value of "," would not insert the separator characters.

If you do not want to override a format setting, set the value of the corresponding parameter to null. In the following code fragment, the setLocaleNumericOptions method is used to override the currency symbol only.

report.setLocaleNumericOptions(null, null, "$");