Difference between revisions of "Extensions.I18n.CompareUntranslatedString"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
[[Category:i18n]]
+
{{DISPLAYTITLE:  '''CompareUntranslatedString '''}}[[Category:i18n]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | CompareUntranslatedString | Comparing an untranslated string with translations of the specified '''TranslationKey''' | [[Term]] | [[i18n|OTX i18n extension]] | [[Translation related terms]] | - | - }}
+
{{ClassificationActivity | CompareUntranslatedString | Comparing an untranslated string with translations of the specified '''TranslationKey''' | [[Term]] | [[Extensions.I18n|OTX i18n extension]] | [[Translation related terms]] | - | - }}
  
 
== Pseudo-Code Syntax ==
 
== Pseudo-Code Syntax ==
Line 11: Line 11:
 
The '''CompareUntranslatedString''' term compares whether an untranslated string matches at least one of the translations of the specified TranslationKey.
 
The '''CompareUntranslatedString''' term compares whether an untranslated string matches at least one of the translations of the specified TranslationKey.
  
{{TermReturnValue| [[Boolean]] | The term will return TRUE if and only if a suitable translation can be found.}}
+
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | The term will return TRUE if and only if a suitable translation can be found.}}
  
 
== 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.TranslationKey|TranslationKey]] | [[Term]] | - | [1] | A unique key that the system uses to locate a translation into internal database.}}
{{TableRowPropertie2| UntranslatedString | [[String]] | [[Term]] | - | [1] | The string to be tested for a match.}}
+
{{TableRowPropertie2| UntranslatedString | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | The string to be tested for a match.}}
 
|}
 
|}
  
Line 30: Line 30:
  
 
== See also ==
 
== See also ==
[[CreateTranslationKey]] <br/>
+
[[Extensions.I18n.CreateTranslationKey|CreateTranslationKey]] <br/>
[[Translate]] <br/>
+
[[Extensions.I18n.Translate|Translate]] <br/>
[[TranslateToLocale]]
+
[[Extensions.I18n.TranslateToLocale|TranslateToLocale]]

Revision as of 09:46, 15 February 2016

Classification

Name CompareUntranslatedString
Short Description Comparing an untranslated string with translations of the specified TranslationKey
Class Term
Extension OTX i18n extension
Group Translation related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

Pseudo-Code Syntax

BooleanTerm = I18n.CompareUntranslatedString(TrasnlationKey, StringTerm);

Description

The CompareUntranslatedString term compares whether an untranslated string matches at least one of the translations of the specified TranslationKey.

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
Boolean The term will return TRUE if and only if a suitable translation can be found.

Properties

Name Data Type Class Default Cardinality Description
TrasnlationKey TranslationKey Term - [1] A unique key that the system uses to locate a translation into internal database.
UntranslatedString String Term - [1] The string to be tested for a match.

OTL Examples

Boolean result;
I18n.TranslationKey TranslationKey1;

TranslationKey1 = I18n.CreateTranslationKey("TEXT_1");
result = I18n.CompareUntranslatedString(TranslationKey1, "vehicles", null);

See also

CreateTranslationKey
Translate
TranslateToLocale