On - Off Switch

Overview

The On/Off switch is similar to the Checkbox and is commonly used for setting a flag type field. This could represent a yes/no, on/off type of choice. Typically the On/Off switch widget is used in mobile applications. Its value property is most often bound to a 1-character field, such as 'Y' / 'N', '0' / '1'. (Rich UI Only)

Field Binding Dialog (Rich UI Only)

Please visit the Field Binding page.

On/Off Switch Properties

on value - This property specifies the value to return when the widget is in the 'on' state.

off value - This property specifies the value to return when the widget is in the 'off' state.

on text - Sets the text displayed when the switch is in the 'on' state. The default value of the property is 'On'. This property may be bound. (Rich UI Only)

off text - Sets the text displayed when the switch is in the 'off' state. The default value of the property is 'Off'. This property may be bound. (Rich UI Only)

wide handle - Sets the size of the handle displayed on the on/off switch for switching. The default value of the property is 'true'. This property may be bound to an indicator. (Rich UI Only)

Example of the wide handle property set to 'true' (default setting):

Example of the wide handle property set to 'false':