Toggle Element
The toggle element adds a toggle switch component to a project’s interface, and is used for binary selection (on or off).
The toggle element is located in the Element Toolbox within Studio’s Application tab.
Properties
The following properties can be changed for the toggle element:
Name
The name of the element.
Visible
The state of the toggle on the interface: visible or hidden.
Initial State
The default state of the toggle: off or on.
Triggers
The following triggers are available to execute events from within the toggle element:
Triggered
Execute an event when the source element connected to the toggle triggers.
Changed
Execute an event when the state of the toggle changes.
Switched On
Execute an event when the toggle is switched on.
Switched Off
Execute an event when the toggle is switched off.
Abilities
The following abilities are available for the toggle element when its source element triggers:
Trigger
Trigger the element(s) that follow the toggle element.
Hide
Hide the toggle.
Show
Display the toggle.
Set State
Set the toggle’s state: off or on.
Set State Arguments | ||
---|---|---|
Name | Type | Description |
State | Boolean | The argument will be true or false. |
Set Visible
Set the toggle’s visibility: visible or hidden.
Set Visible Arguments | ||
---|---|---|
Name | Type | Description |
Visible | Boolean | The argument will be true or false. |