Toggle Switch

This text is AI-generated

This documentation was written with the help of AI and has not been fully reviewed. If something is wrong, unclear or missing, please let us know. Use the feedback form, and say which section it concerns.

The Toggle Switch lets the operator turn a setting on or off. It is found in the Input - OpenBridge section of the Perspective Component Palette as Toggle Switch.

The Toggle Switch is one of the input components. How values are written back, events, disabling and the behavior in the Designer are shared by all of them and are described in Input Components — Common Features. This page covers what is specific to the Toggle Switch.

A Toggle Switch with default properties and label set to Toggle Switch:

A Toggle Switch dropped from the palette is off and has no label.

State

checked sets whether the switch is on:

Off (checked is false)	On (checked is true)

When the operator clicks the switch or its label, or presses Space while it has focus, the new state is written to checked and then onActionPerformed fires.

Bind checked bidirectionally to a tag to connect the switch to it. See Values.

Properties

Name	Description	Property Type
checked	Whether the switch is on. Written when the operator clicks. Default false.	value

---

Label

label is the text to the left of the switch. A click on the label toggles the switch. Leave it empty for a switch without text:

Properties

Name	Description	Property Type
label	Text to the left of the switch. Empty by default.	value

---

Size

The Toggle Switch fills the width of its box: the label is at the left edge and the switch at the right edge. A label that does not fit on one line wraps. The blue frame is the component’s box:

160 px wide	320 px wide

The Toggle Switch is always 56 px high, whatever the height of its box. A new component is 48 px high, so the switch extends 8 px below its box:

Set the height to 56 px to make the box match what is drawn.

---

Disabled

Off	On

See Disabled.

---

Common Properties

These work in the same way on every input component, and are described in Input Components — Common Features:

• Disabled — disabled.
• Appearance — style.

Component Events

Event	Description	Event Object
onActionPerformed	Fired when the operator toggles the switch, after checked is written.	—

See Events.

Examples

Example 1 — Setting Bound to a Tag

1. Drop a Toggle Switch into the view, make it 200 px wide and 56 px high, and set label to Auto start.
2. Bind checked to the tag [default]Pump01/AutoStart and enable Bidirectional.

The switch now shows the tag value, and a click writes the new value to the tag.