Appearance
Toggle
A pill-style switch that reflects and writes a two-state tag.
In Studio
In Studio, double-click Toggle in the Components category of the Components panel. It is added to the open view, where you can drag it into place.
When to use
Use Toggle for a persistent on/off setting an operator can flip directly — an enable/disable flag, a mode select. For a momentary command, use Button instead.
Properties
| Property | Type | Default | Description |
|---|---|---|---|
| Value | String | (none) | Legacy write target, used only when the component has no value binding — see Button's value field for the same contract. |
| Label | String | Toggle | The caption shown beside the switch. |
| On Value | String | true | The value written when the operator switches the toggle ON, and the value the bound tag is compared against to decide whether the switch currently reads ON. |
| Off Value | String | false | The value written when the operator switches the toggle OFF. |
| On Color | Color | #FFFFFF | The switch and knob color when ON. Defaults to the HMI palette's running-state color (white). |
| Off Color | Color | #808080 | The switch and knob color when OFF. Defaults to the HMI palette's stopped-state color (grey). |
| Requires Signature | false, true | false | Same contract as Button's Requires Signature — defers the write to the electronic-signature dialog. |
| Appearance | switch, checkbox | switch | How the toggle is drawn: switch (default, the pill switch) or checkbox (a box with a check mark and the label to its right). Visual only; the value it writes is the same. |
Binding
Click Bind… on the Value property and bind it to a tag or an expression to drive the live value.
To let an operator change the tag from this component, tick Bidirectional (read-write) on the binding. Without it the component only displays the value.
Writes immediately on click, if the value binding is bidirectional. When Requires Signature is set, no local state changes and nothing is written until the signature succeeds.