Class Locale

Provides APIs for localizing applications. You can set or change current locale in your application by setting locale configuration property.

Members Table

The following table lists the members exposed by the Locale object.

Show inherited members (marked with *)

Show: Properties Methods

Attribute Description Property Type Readonly Description culture Object true Currently selected culture object. cultures Object true A mapping of culture codes to culture objects. Method Returns Description addCultureInfo Void Adds new culture information. If baseCulture parameter provided, new culture will inherit its information. Sytaxis: object.addCultureInfo(culture, baseCulture, cultureInfo) Arguments: Name Type O/R Description culture String Required Name of culture being added. baseCulture String Required Name of culture to extend on. cultureInfo Object Required Culture object. Sytaxis: (2) object.addCultureInfo(culture, cultureInfo) Arguments: Name Type O/R Description culture String Required Name of culture being added. cultureInfo Object Required Culture object. format String Formats a date or number according to the given format string and/or the given culture Sytaxis: object.format(value, format, [culture]) Arguments: Name Type O/R Description value Variant Required Date or number value to be formatted. format String Required Format string. culture String Optional Culture identifier. localize String Gets localized text for key. Sytaxis: object.localize(key, [culture]) Arguments: Name Type O/R Description key String Required Key. culture String Optional Culture name. parseDate Date Parses a string representing a date into a JavaScript Date object, taking into account the given possible formats. Sytaxis: object.parseDate(value, formats, [culture]) Arguments: Name Type O/R Description value String Required Value to be parsed. formats Variant Required Format string. culture String Optional Culture name. parseFloat Number Parses a string representing a floating point number in the given radix (10 by default). Sytaxis: object.parseFloat(value, [radix, culture]) Arguments: Name Type O/R Description value String Required Value to be parsed. radix Number Optional Radix (10 by default). culture String Optional Culture name. parseInt Number Parses a string representing a whole number in the given radix (10 by default). Sytaxis: object.parseInt(value, [radix, culture]) Arguments: Name Type O/R Description value String Required Value to be parsed. radix Number Optional Radix (10 by default). culture String Optional Culture name. Event B C Interface Description Pseudo-class Description Constant Value Description

Remarks

Date formats. When more specific control is needed over the formatting, you may create custom formats using custom tokens.

• f - Long Date, Short Time
• F - Long Date, Long Time
• t - Short Time
• T - Long Time
• d - Short Date
• D - Long Date
• Y - Month/Year
• M - Month/Day
• S - Sortable date format "yyyy-MM-ddTHH:mm:ss"

Number formats. For number formats you can also use number next to format identifier to give output string length. For example ample.locale.format(0.12345, "p4") will output 12.3450 % in default en-US locale.

• n - number
• d - decimal digits
• p - percentage
• c - currency

Examples

Setting application locale to South-African Afrikaans language:

ample.config("locale", "af-ZA");