API Language.Translate: Difference between revisions
XML import |
XML import |
||
| Line 3: | Line 3: | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
===Class hierarchy===[[API Language|Language]] | ====Class hierarchy==== | ||
[[API Language|Language]] | |||
:[[API Language|Translate]] | :[[API Language|Translate]] | ||
</div> | </div> | ||
| Line 9: | Line 10: | ||
==Parameters== | ==Parameters== | ||
[[Variable types|STRING]] ''Text'' | |||
:The English text to translate to the Flowcode language | :The English text to translate to the Flowcode language | ||
[[Variable types|STRING]] ''Hint'' | |||
:A contextual single word hint to help the translation | :A contextual single word hint to help the translation | ||
:''The default value for this parameter is: '''''""''' | :''The default value for this parameter is: '''''""''' | ||
| Line 19: | Line 20: | ||
[[Variable types|STRING]] | [[Variable types|STRING]] | ||
No additional information | ''<span style="color:red;">No additional information</span>'' | ||
==Detailed description== | ==Detailed description== | ||
''No additional information'' | ''<span style="color:red;">No additional information</span>'' | ||
==Examples== | ==Examples== | ||
| Line 28: | Line 32: | ||
* Declare a variable 'result' of type STRING | * Declare a variable 'result' of type STRING | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Language.Translate("text", "hint")</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Language.Translate("text", "hint")</pre> | ||
''<span style="color:red;">No additional information</span>'' | |||
Revision as of 22:12, 11 May 2013
<sidebar>API contents</sidebar> Takes English text and optional hint and converts to the current language
Parameters
STRING Text
- The English text to translate to the Flowcode language
STRING Hint
- A contextual single word hint to help the translation
- The default value for this parameter is: ""
Return value
No additional information
Detailed description
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type STRING
- Add to a calculation icon:
result = ::Language.Translate("text", "hint")
No additional information