Skip to main content

Set a Control Value in the Config UI (xui.set)

Declaration​

ok = xui.set(domain, key, value)

Parameters​

  • domain
    String. The defaults domain identifier used by the config UI.
  • key
    String. The control's key identifier in the config UI.
  • value
    Any. Different controls accept different value types.

Returns​

  • ok
    Boolean. true on success; false on failure.

Description​

If the config UI is currently displayed, this function will immediately update the displayed value.
This function does not validate value types. If you need to ensure the saved value type is valid, call xui.setup after setting to validate/correct.
See the config UI standard: XUI

Examples​

xui.set('com.yourcompany.A-Script-Bundle', 'enabled', true)
xui.setup('interface.xui')