CheckBox

Functional reference for CheckBoxObject, including its runtime role and the supported settings available in the design environment.

Updated 7 Oct 2026 2 min read

On this page (7 sections)

Functional explanation
Object name
Variable
Settings
Position / Size
Access Control
Visibility

Functional explanation

CheckBoxObject is a compact boolean control. It is useful where space is limited or where several boolean selections are shown together.

It is best for simple on or off selections and small control areas where a toggle switch would take too much room. The object should remain square so the check mark stays proportional.

Use it for compact option selection and simple boolean write operations. If the state must be very visible from a distance, ToggleObject is usually clearer.

Object name

Set the object name shown in the checkbox decorator context.

Setting	Description	Example	Units
Object Name	Name used to identify the CheckBox object.	EnablePump	Text

Variable

Configure the variable bound to the checked state. A click writes Set when checking and Reset when unchecking, so the field holds one writable variable name. The Variable button opens the variable list and fills in the selected name.

Setting	Description	Example	Units
Variable	Variable bound to the checked state and written on click.	PLC1.EnablePump	Variable name

Settings

Configure the checked state and animation bindings for the CheckBox object.

12 rows

Setting	Description	Example	Units
Checked	Initial or configured checked state.	true	Boolean
On Color	Color used when the checkbox is checked.	#198754	Color
On Background Color	Background color used when the checkbox is checked. A gradient can be used here as well as a single color; see the Gradients section of the Color Library article.	#d1e7dd	Color
On Border Color	Border color used when the checkbox is checked.	#198754	Color
Off Background Color	Background color used when the checkbox is unchecked. A gradient can be used here as well as a single color; see the Gradients section of the Color Library article.	#ffffff	Color
Off Border Color	Border color used when the checkbox is unchecked.	#ced4da	Color
Border Width	Border width used for the checkbox.	1	px
Border Radius	Corner radius of the checkbox border.	4	px
Width Variable	Animation binding for width.	PLC1.CheckBoxWidth	Expression
Height Variable	Animation binding for height.	PLC1.CheckBoxHeight	Expression
Top Variable	Animation binding for top.	PLC1.CheckBoxTop	Expression
Left Variable	Animation binding for left.	PLC1.CheckBoxLeft	Expression

Position / Size

Configure the position and size of the CheckBox object.

Setting	Description	Example	Units
Top	Top position of the object.	100	px
Left	Left position of the object.	220	px
Width	Width of the object.	24	px
Height	Height of the object.	24	px
Z-index	Layer order of the object. Higher values appear in front of lower values.	10	Number

Access Control

Configure access control for the CheckBox object.

Setting	Description	Example	Units
Access Control Enable	Enables access control evaluation for the object.	true	Boolean
Access Control	Expression controlling who can use or see the object.	SYSTEM.UserGroups == "Operators"	Expression
Access Control Filter	CSS filter applied when access control is used to alter the object appearance.	blur(0px) contrast(30%)	CSS filter

Visibility

Configure the runtime visibility and blinking behavior for the CheckBox object.

Setting	Description	Example	Units
Visibility	Expression controlling whether the object is visible.	PLC1.CheckBoxVisible	Expression
Blink	Expression or boolean controlling checkbox blinking.	PLC1.AlarmActive	Boolean or expression
Blink Speed	Blink speed used during runtime.	500	ms
Blink Offset	Blink offset used to stagger blinking between objects.	false	Boolean

Something missing or wrong in this article? Contact us