Difference between revisions of "API Language.Translate"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
(XML import)
Line 2: Line 2:
 
Takes English text and optional hint and converts to the current language
 
Takes English text and optional hint and converts to the current language
  
 +
<div style="width:25%; float:right" class="toc">
 +
===Class hierarchy===
 +
:Language
 +
::Translate
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
 
''[[Variable types|STRING]] Text''
 
''[[Variable types|STRING]] Text''
 
:The English text to translate to the Flowcode language
 
:The English text to translate to the Flowcode language
Line 11: Line 17:
 
:''The default value for this parameter is: '''''""'''
 
:''The default value for this parameter is: '''''""'''
  
===Return value===
+
==Return value==
 
[[Variable types|STRING]]
 
[[Variable types|STRING]]
  
 
No additional information
 
No additional information
  
===Detailed description===
+
==Detailed description==
 
''No additional information''
 
''No additional information''
  
===Examples===
+
==Examples==
====Calling in a calculation====
+
===Calling in a calculation===
 
* Declare a variable 'result' of type STRING
 
* Declare a variable 'result' of type STRING
* Add to a calculation icon: <pre class="brush:[C]">result = ::Language.Translate("text", "hint")</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Language.Translate("text", "hint")</pre>

Revision as of 21:14, 11 May 2013

<sidebar>API contents</sidebar> Takes English text and optional hint and converts to the current language

Class hierarchy

Language
Translate

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

STRING

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")