Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: edits/style, syntax
Scripting_function


Panel
titleDescription

This function allows you to retrieve the global translation of a term from the translation database using the current locale.

Client permissions restrictions


Panel
titleSyntax
Note_friendly

This function accepts keyword arguments.


system.util.translate(term, [locale], [strict])

  • Parameters

String term - The term to look up.

String locale - Which locale to translate against. Useful when there are multiple locales defined for a single term. If omitted, the function attempts to use the current locale (as defined by the client, session, or Designer). [Optionaloptional] 

Boolean strict - If false, the function will return the passed term (param 1) if it could not find a defined translation for the locale: meaning, if you pass a term that hasn't been configured, the function will just send the term back to you. If true, then the function will return a None when it fails to find a defined translation. Default is false. [Optionaloptional] 

  • Returns

String - The translated term.

  • Scope

Gateway, Vision Client, Perspective Session


Panel
titleCode Examples
Code Block
# This script will take a term written into a Text Field component, translate it using the translation database, and then write it back to the same Text Field.
# it uses the current locale since none is specified.

text = event.source.parent.getComponent('Text Field').text
translation = system.util.translate(text)
event.source.parent.getComponent('Text Field').text = translation
Code Block
titlePython - Picking a Local
# This code block demonstrates how to use the locale parameter.

# Use the currently detected locale.
system.util.translate("Hello")

# Translate to Italian.
system.util.translate("Hello", "it")

# Translate to a regional variant - Irish English in this case.
system.util.translate("Hello", "en-ie")  
Panel
titleKeywords

system util translate, util.translate