Difference between revisions of "Extensions.I18n.CreateTranslationKey"
Jump to navigation
Jump to search
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | [[Category:i18n]] | + | {{DISPLAYTITLE: '''CreateTranslationKey'''}}[[Category:i18n]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | CreateTranslationKey | Creates a '''TranslationKey''' from a string | [[Term]] | [[ | + | {{ClassificationActivity | CreateTranslationKey | Creates a '''TranslationKey''' from a string | [[Term]] | [[Extensions.I18n|OTX i18n extension]] | [[Extensions.I18n#Terms|Translation related terms]] | - | - }} |
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | + | TranslationKeyTerm I18n.CreateTranslationKey(StringTerm textId); | |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The '''CreateTranslationKey''' term creates a '''TranslationKey''' | + | The '''CreateTranslationKey''' term creates a '''TranslationKey''' out of a given string. The string is used as the text ID that will be used to create the '''TranslationKey'''. |
| − | {{TermReturnValue| [[TranslationKey]] | '''TranslationKey''' from the given string.}} | + | {{TermReturnValue| [[Extensions.I18n.TranslationKey|TranslationKey]] | '''TranslationKey''' from the given string.}} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{ | + | {{TableRowPropertie2| TextId | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | The string term value provided that will be used to generate a translation key.}} |
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| + | /// Local Declarations | ||
| + | |||
I18n.TranslationKey TranslationKey1; | I18n.TranslationKey TranslationKey1; | ||
| + | |||
| + | /// Flow | ||
TranslationKey1 = I18n.CreateTranslationKey("TEXT_1"); | TranslationKey1 = I18n.CreateTranslationKey("TEXT_1"); | ||
| Line 27: | Line 31: | ||
== See also == | == See also == | ||
| − | [[Translate]] <br/> | + | [[Extensions.I18n.Translate|Translate]] <br/> |
| − | [[TranslateToLocale]] <br/> | + | [[Extensions.I18n.TranslateToLocale|TranslateToLocale]] <br/> |
| − | [[CompareUntranslatedString]] | + | [[Extensions.I18n.CompareUntranslatedString|CompareUntranslatedString]] |
Latest revision as of 06:46, 7 November 2018
Contents
Classification
| Name | CreateTranslationKey |
| Short Description | Creates a TranslationKey from a string |
| Class | Term |
| Extension | OTX i18n extension |
| Group | Translation related terms |
| Exceptions | - |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
TranslationKeyTerm I18n.CreateTranslationKey(StringTerm textId);Description
The CreateTranslationKey term creates a TranslationKey out of a given string. The string is used as the text ID that will be used to create the TranslationKey.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| TranslationKey | TranslationKey from the given string. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| TextId | String | Term | - | [1] | The string term value provided that will be used to generate a translation key. |
OTL Examples
/// Local Declarations
I18n.TranslationKey TranslationKey1;
/// Flow
TranslationKey1 = I18n.CreateTranslationKey("TEXT_1");