Element: messagefile.current_language

Type

string

Description

The code of the current language for the message file. Message files may be multi-language and any call to the messagefile.text function to retrieve text will retrieve the text for the current language.

The language codes available for multi-language message files are those accepted by international locales, e.g. en_us (American English), fr (French), fr_ca (Canadian French) etc., and the value of this attribute will be one of these. The language codes available for a particular message file can be retrieved by the messagefile.languages string array.

Setting this attribute to one of the available codes will determine which language is used on the next call to messagefile.text.

Single-language message files have no concept of a current language so the value of this attribute will always be an empty string.

Example

Declare a mulit-language message file, then display one of its messages in various languages:

messagefile mf='international.mes'
 
# The following might display "Good morning" ...
tell mf.text(1,1)
 
# but the following might display "G'day"
mf.current_language='en_au'
tell mf.text(1,1)
 
# ... then "Bonjour"
mf.current_language='fr'
tell mf.text(1,1)
 
# ... then "Bon giorno"
mf.current_language='it'
tell mf.text(1,1)