Difference between revisions of "Extensions.I18n.Translate"

From emotive
Jump to navigation Jump to search
m (Hb moved page Translate to Extensions.I18n.Translate: #3153)
Line 1: Line 1:
[[Category:i18n]]
+
{{DISPLAYTITLE:  '''Translate '''}}[[Category:i18n]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | Translate | Returns a localized string from a '''TranslationKey''' | [[Term]] | [[i18n|OTX i18n extension]] | [[Translation related terms]] | - | - }}
+
{{ClassificationActivity | Translate | Returns a localized string from a '''TranslationKey''' | [[Term]] | [[Extensions.I18n|OTX i18n extension]] | [[Translation related terms]] | - | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
Line 11: Line 11:
 
The '''Translate''' term accepts a ''TranslationKey'' argument and returns a localized string in the current user language.
 
The '''Translate''' term accepts a ''TranslationKey'' argument and returns a localized string in the current user language.
  
{{TermReturnValue| [[String]] | Localized string in the current user language.}}
+
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | Localized string in the current user language.}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| TrasnlationKey | [[TrasnlationKey]] | [[Term]] | - | [1] | A unique key that the system uses to locate a translation into internal database.}}
+
{{TableRowPropertie1| TrasnlationKey | [[Extensions.I18n.TrasnlationKey|TrasnlationKey]] | [[Term]] | - | [1] | A unique key that the system uses to locate a translation into internal database.}}
 
|}
 
|}
  
Line 29: Line 29:
  
 
== See also ==
 
== See also ==
[[CreateTranslationKey]] <br/>
+
[[Extensions.I18n.CreateTranslationKey|CreateTranslationKey]] <br/>
[[TranslateToLocale]] <br/>
+
[[Extensions.I18n.TranslateToLocale|TranslateToLocale]] <br/>
[[CompareUntranslatedString]]
+
[[Extensions.I18n.CompareUntranslatedString|CompareUntranslatedString]]

Revision as of 09:41, 15 February 2016

Classification

Name Translate
Short Description Returns a localized string from a TranslationKey
Class Term
Extension OTX i18n extension
Group Translation related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

StringTerm = I18n.Translate(TrasnlationKey, Arguments);

Description

The Translate term accepts a TranslationKey argument and returns a localized string in the current user language.

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
String Localized string in the current 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.

OTL Examples

I18n.TranslationKey TranslationKey1;
String result;

TranslationKey1 = I18n.CreateTranslationKey("TEXT_1");
result = Translate(TranslationKey, null);

See also

CreateTranslationKey
TranslateToLocale
CompareUntranslatedString