You are here: Core Reference > Coding > Scripting > CheckBox.Checked

CheckBox.Checked

The CheckBox Control Object that is returned by the AddCheckBox function has a Checked property. The Checked property defines whether the check box is selected (displays a check mark).

Syntax

ControlObject.Checked = Value

Where ControlObject. is the name of the variable (declared in your script) that is used to store the CheckBox Control Object that is returned by the AddCheckBox function.

Description

Sets the check box to selected (filled with a check mark) or clear.

Arguments

Value {Boolean}

If set to True (1), the Check Box is selected automatically by default; if set to False (0) it is clear.

Returns

Boolean

Example:

CheckBox1.Checked = 1

Where:

  • CheckBox1 is the name of the variable that stores the CheckBox Control Object returned by the AddCheckBox function
  • 1 sets the Check Box to selected.

ClearSCADA 2015 R2