SetLanguage

Set the language for this client instance.

Function

void SetLanguage(language: string)

Parameters

  • language (string): the language to set this client to.

Remarks

Languages are set up at a project level. A full explanation of that process is out of scope for this documentation. Suffice it to say that in addition to the default language, one can define extra languages – these are the languages returned by GetLanguages – and keywords that when wrapped with {{ and }} will be replaced with the language specific phrase.

This substitution occurs in 3D labels, tooltips, and Sym3Label Text fields.

If the language you pass is not defined, an Error will be thrown. Languages are case sensitive.

If a null, undefined, or an empty string is passed, the language will be set to the default language.

Example

Set the current language to Japanese.

SYM3.SetCurrentLanguage("Japanese");