Home
CONTROL
CONTROL Functions
Functions T
tr()
The function translates the given combination (text, comment) into the requested language or the UI language if the lang argument is not given.

CONTROL
- Introduction to CTRL
- Control Classes
- Types of Control Functions
- Control graphics
- CONTROL Functions
  - Funtions A
  - Funtions B
  - Funtions C
  - Funtions D
  - Functions E
  - Functions F
  - Functions G
  - Functions H
  - Functions I
  - Functions J
  - Functions K
  - Functions L
  - Functions M
  - Functions N
  - Functions O
  - Functions P
  - Functions Q
  - Functions R
  - Functions S
  - Functions T
    - textEditor()
      Opens the text editor as a main window (not modally).
    - The Extension timedFuncConflicts()
      The timed function extension "timedFuncConflicts()" is designed to discover call conflicts between two or more timed functions. It compares the given parameters to analyze all conflicts and returns the result times.
    - trackZoomMode()
      Complies with the function "Rubber band zoom". After calling this function a cursor "cross" is displayed, which allows to create a window by left-clicking. The panel is scaled in accordance with the specified window size.
    - tanh()
      Calculates the hyperbolic tangent.
    - triggerAction()
      The function can be used to trigger an action from a GEDI or Script Editor extension script.
    - tan()
      Calculates the tangent.
    - tcpRead()
      Reads the data of a defined socket, which was opened with tcpOpen().
    - timedFuncEvents()
      The function timedFuncEvents() returns up to a given max_count all planned start_times (occurrences) when WinCC OA timedFunc would trigger a (start-)event. This function also handles the time periods (broadcast periods) (see Timed function extension) within the range defined by ’r;valid from’ and ’r;valid until’.
    - tr()
      The function translates the given combination (text, comment) into the requested language or the UI language if the lang argument is not given.
    - tcpShutdownOutput()
      Closes the write direction of a TCP socket.
    - timeFromGMT()
      Returns the difference between local time and GMT.
    - Timed function extension
      The timed function was extended and now provides several new functions:
    - throw()
      Signals an erroneous condition by using an error class variable.
    - tcpOpen()
      Opens the connection to a TCP/IP server socket.
    - triggerGlobalEvent()
      The function triggers a UI global event.
    - tcpWrite()
      Writes data to the defined socket.
    - timedFunc()
      Starts timed CTRL functions.
    - titleBar()
      Shows or hides the title bar in the specified module or in a child panel.
    - triggerEvent()
      The function triggers a specific event.
    - tcpClose()
      Closes a TCP/IP socket connection.
    - triggerEventWait()
      The function triggers a specific event and waits for the execution of the event.
    - throwError()
      Passes a WinCC OA error to the internal error handler.
    - tmpnam()
      Creates temporary file names.
  - Functions U
  - Functions V
  - Functions W
  - Functions X
  - Functions Y
  - Functions Z
- CtrlExtension, basics
- CTRL Debugger
  You can use the CTRL debugger to debug the Control programming language. The debugger can be used via its own panel, which also enables the monitoring and setting of variable values during the execution of a script.

tr()

The function translates the given combination (text, comment) into the requested language or the UI language if the lang argument is not given.

Synopsis

string tr(string sourceTerm, string comment = "" [, int|string|OaLanguage lang]);

Parameters


Parameter	Description
sourceTerm	The used term in the source/ Param language
comment	A comment that modifies the translation. The default is an empty string.
lang	An optional parameter for specifying a translation language to be used.

Error

The function throws an exception in case of errors (e.g.: invalid lang parameter).

Description

The function uses the sourceTerm to mark the text as translatable and retrieve the translation for it. The translation is taken from the translation files created with the Translator.

The translation can be made more precise by adding a comment. This enables the use of multiple translations for one source term, depending on which comment is added.

Note: The text and comment given should be a literal string (not an expression or variable) so that the step is able to extract given text and comment combination as translatable text.

Note: This function can be used to add translations if a lang string interface is not available.

Note: This function acts as a functional replacement for getCatStr() in conjunction with the use of the new Translator.

Making a dyn_string with a normal string and a translated string:

makeDynString("$1:" + tr("The target path on the Backup tab is empty!\nYour changes will not be saved!")));

Adding a translated tooltip:

cmdStartCtrlDbg.toolTipText = tr(\"Start Manager for Debugging and break new threads\");

Adding a label, but the translation remains only german:

string deText = tr("Update Translation", "", OaLanguage::de_AT);
Label1.text(deText);

Translating a string and substituting some placeholders via "subst" (string::subst):

DebugN(tr("The file $1 could not be read due to error $2").subst(fileName, eror));

With this, the constant string literal in the tr() function call can be extracted by projectTranslationUpdate() and during runtime the translated text will be shown with the $-Parameters replaced with given arguments.

Assignment

Multi-language capability

Availability

CTRL