Difference between revisions of "Extensions.I18n.LocalizeQuantity"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
 
{{DISPLAYTITLE:  '''LocalizeQuantity '''}}[[Category:i18n]]
 
{{DISPLAYTITLE:  '''LocalizeQuantity '''}}[[Category:i18n]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | LocalizeQuantity | Creates a localized version of a NumericQuantity | [[Term]] | [[Extensions.I18n|OTX i18n extension]] | [[Quantity related terms]] | [[Core.Actions.Throw.Exception.InvalidConversionException|InvalidConversionException]] | - }}
+
{{ClassificationActivity | LocalizeQuantity | Creates a localized version of a given Quantity| [[Term]] | [[Extensions.I18n|OTX i18n extension]] | [[Extensions.I18n#Terms|Quantity related terms]] | [[Extensions.Quantities.InvalidConversionException|InvalidConversionException]] | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
Line 9: Line 9:
  
 
== Description ==
 
== Description ==
The '''LocalizeQuantity''' term is used to provide a localized version of a particular ''NumericQuantity'' create.
+
The '''LocalizeQuantity''' term is used to create a localized version of a given '''Quantity'''.
  
{{TermReturnValue| [[Extensions.Quantities.Quantity|Quantity]] | A localized version of a particular NumericQuantitys.}}
+
Localization in the '''LocalizeQuantity''' term shall always be performed using the current locale.
 +
 
 +
{{TermReturnValue| [[Extensions.Quantities.Quantity|Quantity]] | A localized version of a given '''Quantity'''.}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| Quantity | [[Extensions.Quantities.Quantity|Quantity]] | [[Term]] | - | [1] | The Quantity that is localized to the current locale.}}
+
{{TableRowPropertie1| Quantity | [[Extensions.Quantities.Quantity|Quantity]] | [[Term]] | - | [1] | This represents the Quantity that shall be localized to the current locale.}}
 
|}
 
|}
  
Line 23: Line 25:
 
Quantities.Quantity Quantity1;
 
Quantities.Quantity Quantity1;
 
Quantities.Quantity Quantity2;
 
Quantities.Quantity Quantity2;
 +
 +
/// Flow
  
 
Quantity2 = I18n.LocalizeQuantity(Quantity1);
 
Quantity2 = I18n.LocalizeQuantity(Quantity1);

Revision as of 11:35, 28 September 2018

Classification

Name LocalizeQuantity
Short Description Creates a localized version of a given Quantity
Class Term
Extension OTX i18n extension
Group Quantity related terms
Exceptions InvalidConversionException
Checker Rules -
Standard Compliant Yes

OTL Syntax

QuantityTerm = I18n.LocalizeQuantity(QuantityTerm);

Description

The LocalizeQuantity term is used to create a localized version of a given Quantity.

Localization in the LocalizeQuantity term shall always be performed using the current locale.

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
Quantity A localized version of a given Quantity.

Properties

Name Data Type Class Default Cardinality Description
Quantity Quantity Term - [1] This represents the Quantity that shall be localized to the current locale.

OTL Examples

Quantities.Quantity Quantity1;
Quantities.Quantity Quantity2;

/// Flow

Quantity2 = I18n.LocalizeQuantity(Quantity1);

See also

LocalizeQuantityToUnitGroup