Home > Class Reference > ENSLIB namespace > %SYS.NLS.Locale

%SYS.NLS.Locale

class %SYS.NLS.Locale extends %Library.RegisteredObject

Exposes some properties and methods associated with a locale. If no locale is given to %New(), then the current one is used.

For system and process NLS table settings see %SYS.NLS.Table.
For current device NLS properties see %SYS.NLS.Device.
For date, time and number format properties see %SYS.NLS.Format.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property CharacterSet as %String;
Name of character set on which the current locale is based.
Property methods: CharacterSetDisplayToLogical(), CharacterSetGet(), CharacterSetIsValid(), CharacterSetLogicalToDisplay(), CharacterSetLogicalToOdbc(), CharacterSetNormalize(), CharacterSetSet()
property CollationTables as %String;
List of available collation tables.
Property methods: CollationTablesDisplayToLogical(), CollationTablesGet(), CollationTablesIsValid(), CollationTablesLogicalToDisplay(), CollationTablesLogicalToOdbc(), CollationTablesNormalize(), CollationTablesSet()
property Country as %String;
Country supported by the current locale.
Property methods: CountryAbbrDisplayToLogical(), CountryAbbrGet(), CountryAbbrIsValid(), CountryAbbrLogicalToDisplay(), CountryAbbrLogicalToOdbc(), CountryAbbrNormalize(), CountryAbbrSet(), CountryDisplayToLogical(), CountryGet(), CountryIsValid(), CountryLogicalToDisplay(), CountryLogicalToOdbc(), CountryNormalize(), CountrySet()
property CountryAbbr as %String;
ISO 3166-1 alpha-2 two-letter abbreviation of Country.
Property methods: CountryAbbrDisplayToLogical(), CountryAbbrGet(), CountryAbbrIsValid(), CountryAbbrLogicalToDisplay(), CountryAbbrLogicalToOdbc(), CountryAbbrNormalize(), CountryAbbrSet()
property Currency as %String;
Currency symbol.
Property methods: CurrencyDisplayToLogical(), CurrencyGet(), CurrencyIsValid(), CurrencyLogicalToDisplay(), CurrencyLogicalToOdbc(), CurrencyNormalize(), CurrencySet()
property Description as %String;
Short description of the current locale.
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property IdentifierTables as %String;
List of available identifier tables.
Property methods: IdentifierTablesDisplayToLogical(), IdentifierTablesGet(), IdentifierTablesIsValid(), IdentifierTablesLogicalToDisplay(), IdentifierTablesLogicalToOdbc(), IdentifierTablesNormalize(), IdentifierTablesSet()
property Language as %String;
Localization language for the current locale.
Property methods: LanguageAbbrDisplayToLogical(), LanguageAbbrGet(), LanguageAbbrIsValid(), LanguageAbbrLogicalToDisplay(), LanguageAbbrLogicalToOdbc(), LanguageAbbrNormalize(), LanguageAbbrSet(), LanguageDisplayToLogical(), LanguageGet(), LanguageIsValid(), LanguageLogicalToDisplay(), LanguageLogicalToOdbc(), LanguageNormalize(), LanguageSet()
property LanguageAbbr as %String;
ISO 639-1 two-letter abbreviation of Language.

In a few cases, where the language is used by more than one country, this abbreviation is hyphenated with the uppercase abbreviation of the country. For example, en-US, en-GB, pt-BR.
Property methods: LanguageAbbrDisplayToLogical(), LanguageAbbrGet(), LanguageAbbrIsValid(), LanguageAbbrLogicalToDisplay(), LanguageAbbrLogicalToOdbc(), LanguageAbbrNormalize(), LanguageAbbrSet()
property LowerCaseTables as %String;
List of available lower-case tables.
Property methods: LowerCaseTablesDisplayToLogical(), LowerCaseTablesGet(), LowerCaseTablesIsValid(), LowerCaseTablesLogicalToDisplay(), LowerCaseTablesLogicalToOdbc(), LowerCaseTablesNormalize(), LowerCaseTablesSet()
property Name as %String;
Code name of the current locale.
Property methods: NameDisplayToLogical(), NameGet(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property PatternTables as %String;
List of available pattern match tables.
Property methods: PatternTablesDisplayToLogical(), PatternTablesGet(), PatternTablesIsValid(), PatternTablesLogicalToDisplay(), PatternTablesLogicalToOdbc(), PatternTablesNormalize(), PatternTablesSet()
property TitleCaseTables as %String;
List of available title-case tables.
Property methods: TitleCaseTablesDisplayToLogical(), TitleCaseTablesGet(), TitleCaseTablesIsValid(), TitleCaseTablesLogicalToDisplay(), TitleCaseTablesLogicalToOdbc(), TitleCaseTablesNormalize(), TitleCaseTablesSet()
property UpperCaseTables as %String;
List of available upper-case tables.
Property methods: UpperCaseTablesDisplayToLogical(), UpperCaseTablesGet(), UpperCaseTablesIsValid(), UpperCaseTablesLogicalToDisplay(), UpperCaseTablesLogicalToOdbc(), UpperCaseTablesNormalize(), UpperCaseTablesSet()
property XLTTables as %String;
List of available translation (i/o) tables
Property methods: XLTTablesDisplayToLogical(), XLTTablesGet(), XLTTablesIsValid(), XLTTablesLogicalToDisplay(), XLTTablesLogicalToOdbc(), XLTTablesNormalize(), XLTTablesSet()
property XYTables as %String;
List of available $X/$Y tables.
Property methods: XYTablesDisplayToLogical(), XYTablesGet(), XYTablesIsValid(), XYTablesLogicalToDisplay(), XYTablesLogicalToOdbc(), XYTablesNormalize(), XYTablesSet()

Methods (Including Private)

classmethod GetLanguage(Loc As %String = "") as %List
Returns the language associated with a locale as
$LB({Property LanguageAbbr},{Property Language})

Parameters:
  • Loc - Locale code (optional)
If the locale code is not given, use the current locale.

Inherited Members

Inherited Methods (Including Private)