Service: UX

Accessing UX resources (e.g., images and translations)

Provides access to data resources used for the UI, like language dictionaries and images.

Functions

Result	Name / Params			Comment
string[]	ux.GetAvailableLanguages			Returns the list of all available language codes.
LanguageDesc[]	ux.GetLanguageDesc			Returns the list of all available language descriptions.
LanguageData[]	ux.GetLanguageData			Gets the language data of all languages defined by the request.
		namespaces	string[]	(Optional) Identifier of the language data that shall be returned. If it is empty, everything is returned. Values are WinGuard, @User, <‍Extension‍>, where <‍Extension‍> is the Localizer namespace of an Extension language resource. The @User data contains all overwritten language IDs, merging them is up to the API user.
		languages	string[]	(Optional) The list of languages to return. If it is empty, all languages are returned.
bool	ux.SetLanguageData			Updates user language data.
bool		languages	LanguageData[]	Overwrite the user language data with the given data. Namespace must be @User. Language IDs can be overwritten by prefixing the namespace in the Id of the corresponding LanguageDataEntry.
LanguageData	ux.GetLanguageDictionary			Requests the language dictionary for the given language code. The language is extended with user and system resources.
LanguageData		language	string	Language code of the dictionary to return.
string[]	ux.GetAvailableThemes			Returns the keys of all available themes.
ThemeData	ux.GetThemeData			Gets the data of the current CST theme selected in WinGuard.
		items	string[]	(Optional) A list of item types that shall be returned (colors, images, props). If it is empty, everything is returned.
		id ≥wg.core 0.0.3	string	(Optional) Theme ID (arctic, light_grey, ...).

Notifications

Name / Params			Comment
ux.LanguageDataUpdated			Notifies change of current language.
	id	string	Language code (de, en, ...).
ux.LanguageDictionaryUpdated
	language	string	Code of the language that was updated.
ux.ThemeDataUpdated			Notifies change of current theme.
	id	string	Theme ID (arctic, light_grey, ...).

Objects

LanguageData

Property	Type	Description
Namespace	string	Namespace of the language (WinGuard, @User, <‍Extension‍>).
LngId	string	Language code (de, en, …).
IsRtl	bool	Flag indicating whether the language is RightToLeft.
Dictionary	LanguageDataEntry[]	Language strings, identified by their string ID.

LanguageDataEntry

Property	Type	Description
Id	string	ID of the language string.
Value	string	Localized string.

ThemeData

Property	Type	Description
Colors	string{}	CST color IDs with their corresponding colors as hex color strings (e.g. #FF00FF).
Images	ImageData[]	CST images with metadata, identified by their string IDs.
Props	value{}	Special properties to modify CST values.

ImageData

Property	Type	Description
Id	string	ID of the image.
Width	int	Width in pixel.
Height	int	Height in pixel.
Data	data	Base64 encoded image data (usually PNG).

LanguageDesc

Property	Type	Description
Code	string	Language code.
Name	string	Localized name of the language.
Symbol	string	Language symbol.

Last modified September 25, 2026