Checkbox

This text is AI-generated — we need your feedback

This documentation was written with the help of AI and has not been fully reviewed. If something is wrong, unclear or missing, please tell us: open the feedback form, say which section it concerns and what you expected to read. The same link is at the bottom of every page.

The Checkbox lets the operator turn a single option on or off. It is found in the Input - OpenBridge section of the Perspective Component Palette as Checkbox.

The Checkbox 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 Checkbox.

A Checkbox with default properties and label set to Checkbox:

A Checkbox dropped from the palette is unchecked and has no label.

State

The checkbox has three states, set with checked and mixed:

Unchecked	Checked	Mixed

• Checked — checked is true.
• Mixed — mixed is true and checked is false. Use it for a checkbox that stands for a group of options of which only some are selected.
• Unchecked — both are false.

If both checked and mixed are true, the checkbox is shown as checked.

When the operator clicks the checkbox, it writes the new state to checked and mixed and then fires onActionPerformed. A click on a mixed checkbox checks it; after that, clicks alternate between unchecked and checked. The operator cannot set the mixed state — set mixed from a binding or a script.

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

Properties

Name	Description	Property Type
checked	Whether the checkbox is checked. Written when the operator clicks. Default false.	value
mixed	Whether the checkbox is in the mixed state. Written (to false) when the operator clicks. Default false.	value
status	Deprecated. Use checked and mixed. Leave it empty.	value

---

Label

label is the text next to the box. A click on the label toggles the checkbox. Leave it empty for a checkbox without text, for instance in a table row.

Properties

Name	Description	Property Type
label	Text next to the box. Empty by default.	value

---

Disabled

Unchecked	Checked	Mixed

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 clicks the checkbox, after checked and mixed are written.	—

See Events.

Examples

Example 1 — Option Bound to a Tag

1. Drop a Checkbox into the view and set label to Auto start.
2. Bind checked to the tag [default]Pump01/AutoStart and enable Bidirectional.

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