Configuring Siebel Open UI > Siebel Open UI Application Programming Interface > Classes and Methods of the Siebel Open UI Application Programming Interface >

Locale Object Class

This topic describes the Locale Object class.

GetLocalString Method

Given a key, the GetLocalString method returns the localized string for this key.

This method uses the following parameters:

pStringKey : String : message key

The following code includes an example of this method:

SiebelApp.S_App.LocaleObject.GetLocalString("IDS_SWE_LOADING_INDICATOR_TITLE")

FormattedToString Method

The FormattedToString method removes the formatting of a string. It returns the unformatted string

This method uses the following parameters:

• type. Identifies the value type of the string. For example: Phone, Currency, DateTime, or Integer.
• value. Identifies the formatted value of the string.
• format. Identifies the optional format of the string.

The following code includes an example of this method:

SiebelApp.S_App.LocaleObject.FormattedToString("date","11/05/2012","M/D/YYYY")

StringToFormatted Method

The StringToFormatted method adds formatting characters to a string. It returns a formatted string

This method uses the same parameters that the FormattedToString method uses. For more information, see FormattedToString Method.

The following code includes an example usage of this method:

SiebelApp.S_App.LocaleObject.StringToFormatted("date","11/05/2012","M/D/YYYY")

GetCurrencyList Method

The GetCurrencyList method returns the currency list that the client computer supports.

This method does not include any parameters.

The following code includes an example usage of this method:

SiebelApp.S_App.LocaleObject.GetCurrencyList()

GetDateFormat Method

The GetDateFormat method returns the date format for the locale.

This method does not include any parameters.

The following code includes an example usage of this method:

SiebelApp.S_App.LocaleObject.GetDateFormat()

GetDayOfWeek Method

The GetDayOfWeek method returns a string that includes a value that identifies the name of the day of the week.

This method uses the following parameters:

• nDay. A number that indicates the index of the day.
• type. A string that indicates the day format.

The following code includes an example usage of this method:

SiebelApp.S_App.LocaleObject.GetDayOfWeek(20,"M/D/YYYY")

GetDispCurrencyDecimal Method

The GetDispCurrencyDecimal method returns the decimal point symbol that the client uses for currency, such as a period (.).

This method does not include any parameters.

The following code includes an example usage of this method:

SiebelApp.S_App.LocaleObject.GetDispCurrencyDecimal()

GetDispCurrencySeparator Method

The GetDispCurrencySeparator method returns the symbol that the client uses to separate digits in a currency, such as a comma (,).

This method does not include any parameters.

The following code includes an example usage of this method:

SiebelApp.S_App.LocaleObject.GetDispCurrencySeparator()

GetDispDateSeparator Method

The GetDispDateSeparator method returns the symbol that the client uses to separate the days, weeks, and months of a date.

This method does not include any parameters.

The following code includes an example usage of this method:

SiebelApp.S_App.LocaleObject.GetDispDateSeparator()

GetDispNumberDecimal Method

The GetDispNumberDecimal method returns the symbol that the client uses for the decimal point symbol. For example, a period (.).

This method does not include any parameters.

The following code includes an example usage of this method:

SiebelApp.S_App.LocaleObject.GetDispNumberDecimal())

GetDispNumberScale Method

The GetDispNumberScale method returns number of fractional digits that the client displays. For example, 2.

This method does not include any parameters.

The following code includes an example usage of this method:

SiebelApp.S_App.LocaleObject.GetDispNumberScale()

GetDispNumberSeparator Method

The GetDispNumberSeparator method returns the symbol that the client uses to separate digits in a number. For example, the comma (,).

This method does not include any parameters.

The following code includes an example usage of this method:

SiebelApp.S_App.LocaleObject.GetDispNumberSeparator())

GetDispTimeAM Method

The GetDispTimeAM method returns the localized string for AM. For example, AM.

This method does not include any parameters.

The following code includes an example usage of this method:

SiebelApp.S_App.LocaleObject.GetDispTimeAM()

GetDispTimePM Method

The GetDispTimePM method returns the localized string for PM. For example, PM.

This method does not include any parameters.

The following code includes an example usage of this method:

SiebelApp.S_App.LocaleObject.GetDispTimePM()

GetDispTimeSeparator Method

The GetDispTimeSeparator method returns the symbol that the client uses to separate the parts of time.

This method does not include any parameters.

The following code includes an example usage of this method:

SiebelApp.S_App.LocaleObject.GetDispTimeSeparator()

GetFuncCurrCode Method

The GetFuncCurrCode method returns the currency code that the client uses. For example, USD.

This method does not include any parameters.

The following code includes an example usage of this method:

SiebelApp.S_App.LocaleObject.GetFuncCurrCode()

GetMonth Method

The GetMonth method returns the month from the locale.

This method does not include any parameters.

The following code includes an example usage of this method:

SiebelApp.S_App.LocaleObject.GetMonth()

GetScale Method

The GetScale method returns the scale of the number that Siebel Open UI must display.

This method does not include any parameters.

The following code includes an example usage of this method:

SiebelApp.S_App.LocaleObject.GetScale()

GetStringFromDateTime Method

The GetStringFromDateTime method returns a reformatted date and time string

This method does not include any parameters.

The following code includes an example usage of this method:

SiebelApp.S_App.LocaleObject.GetStringFromDateTime(2012-12-05, DD/MM/YYYY, M/D/YYYY)

GetTimeFormat Method

The GetTimeFormat method returns the time format that the locale uses.

This method does not include any parameters.

The following code includes an example usage of this method:

SiebelApp.S_App.LocaleObject.GetTimeFormat()

GetTimeZoneList Method

The GetTimeZoneList method returns a list of time zones that the locale uses.

This method does not include any parameters.

The following code includes an example usage of this method:

SiebelApp.S_App.LocaleObject.GetTimeZoneList()

GetTimeZoneName Method

The GetTimeZoneName method returns the time zone that the locale uses.

This method does not include any parameters.

The following code includes an example usage of this method:

SiebelApp.S_App.LocaleObject.GetTimeZoneName()

GetExchangeRate Method

The GetExchangeRate method calculates the exchange rate between two currencies. It returns the exchange rate as a double precision, floating point number.

This method uses the following parameters:

• From. A string that includes the input value of the currency code that Siebel Open UI uses to calculate the exchange rate.
• To. A string that includes the output value of the currency code that Siebel Open UI calculates.
• exchangeDate. A string that includes the date of the currency exchange.

The following code includes an example usage of this method:

SiebelApp.S_App.LocaleObject.GetExchangeRate("USD", "INR", "11/05/2012")

SetCurrencyCode Method

The SetCurrencyCode method sets the currency code for the locale. It returns nothing.

This method uses the following parameters:

sCurrCode : String : Currency code

The following code includes an example usage of this method:

SiebelApp.S_App.LocaleObject.SetCurrencyCode("USD")

SetExchDate Method

The SetExchDate method sets the exchange date for the currency. It returns nothing.

This method uses the following parameters:

nExchDate : Exchange date

The following code includes an example usage of this method:

SiebelApp.S_App.LocaleObject.SetExchDate("11/05/2012")

SetScale Method

The SetScale method sets the scale of the number. It returns nothing.

This method uses the following parameters:

nScale : Number : Scale

The following code includes an example usage of this method:

SiebelApp.S_App.LocaleObject.SetScale("0")