Check box

About 3 min read

TwCheckBox · Category: Basic

Settings

These settings are in the properties panel on the right while the widget is selected, mostly in the Check Box Settings section. The default value is the value the widget has when it is first added to a page.

Value / Write

Setting	Type	Default	Description
On Value onValue	Value (typed)	true	Value written when Toggle/Switch is ON.
Off Value offValue	Value (typed)	false	Value written when Toggle/Switch is OFF.
Process Value processValue	Value (typed)	-1	Main value of the widget, usually bound to a Tag or an expression in Bindings.

Behavior

Setting	Type	Default	Description
Read Only readOnly	Checkbox	On	When on, the user cannot change the value at runtime.
Needs Confirmation needsConfirmation	Checkbox	Off	Asks for confirmation before the value is written to the Tag.

Labels / Icons

Setting	Type	Default	Description
Text text	Text	—	Text shown next to the box. Empty shows only the box.
Icon Size (px) iconSize	Number	—	Size of the box in pixels. Values below 10 are ignored and the default size is used.
Hint hint	Text	—	Tooltip text shown at runtime when the pointer rests on the widget.
Checked Icon Source checkedIconSrc	File	—	Image shown instead of the box when checked. If only one image is set, it is used for both states.
Unchecked Icon Source uncheckedIconSrc	File	—	Image shown instead of the box when unchecked. If only one image is set, it is used for both states.

Other settings

Setting	Type	Default	Description
Enable Flashing enableFlashing	Checkbox	Off	Makes the widget blink (an opacity pulse every second). Usually bound to an alarm condition.
Log Button logButton	Checkbox	Off	At runtime shows a chart icon when hovering the widget; clicking it adds the Tags bound to the widget to the log Tag list.

Bindings

In the Bindings (Rules) section of the properties panel, a Tag can be bound to the following properties of this widget with a Direct binding. The binding types (Direct, IntRange, FloatRange, Boolean, Bit) are the same for all widgets; they are described on the Widget Reference page.

title, visible, authorization, x, y, width, height, rotation, class, foregroundColor, backgroundColor, borderColor, borderStyle, borderWidth, borderRadius, borderTopLeftRadius, borderTopRightRadius, enableFlashing, logButton, onClick, onMouseDown, onMouseUp, readOnly, needsConfirmation, hint, text, iconSize, onValue, offValue, processValue, onChange, checkedIconSrc, uncheckedIconSrc

Common sections

While this widget is selected, the properties panel also shows these common sections: General, Layout, Appearance, Events, Bindings (Rules). These sections are described on the Page Editor page.