Extensions.I18n.TranslateToLocale

Classification

Name	TranslateToLocale
Short Description	Returns a localized string from a TranslationKey after the target locale
Class	Term
Extension	OTX i18n extension
Group	Translation related terms
Exceptions	UnsupportedLocaleException
Checker Rules	-
Standard Compliant	Yes

Pseudo-Code Syntax

String TranslateToLocale(TrasnlationKey translationKey, String locale);

Description

The TranslateToLocale term has a similar function as the Translate term, but instead of the current locale, it should use a target locale, which is given as an argument.

Return Value

The Term returns the value, see table below.

In OTX, Terms are categorized according to its return data type!

Data Type	Description
String	Localized string in the specified user language.

Properties

Name	Data Type	Class	Default	Cardinality	Description
TrasnlationKey	TrasnlationKey	Term	-	[1]	A unique key that the system uses to locate a translation into internal database.
locale	String	Term	-	[1]	The translation process is this string as the target locale to use for the translation.

Examples

String result = TranslateToLocale(translationKey, locale);

See also

CreateTranslationKey
Translate
CompareUntranslatedString