Skip to main content
Version: 8.3 Beta 🚧

system.vision.setLocale

Backwards Compatibility

This function replaces system.util.setLocale. Any scripts containing Vision Client scoped functions that were replaced with system.vision syntax will still work to maintain backwards compatibility. Only the system.vision variations will appear in the Script Editor's autocomplete popup.

This function is used in Python Scripting.

Description​

Sets the user's current Locale. Any valid Java locale code (case-insensitive) can be used as a parameter, including ones that have not yet been added to the Translation Manager. An invalid locale code will cause an Illegal Argument Exception.

Client Permission Restrictions​

This scripting function has no Client Permission restrictions.

Syntax​

system.vision.setLocale(locale)

Parameters​

TypeParameterDescription
ObjectlocaleA locale code, such as "en_US" for US English, or a java.util.Locale object.

Returns​

Nothing

Scope​

Vision Client

Code Examples​

Example #1
# This script will set the client locale to Arabic.

system.vision.setLocale('ar')