You are here: Core Reference > Coding > Scripting > Form.AddCheckBox

Form.AddCheckBox

The AddCheckBox function allows the script to add a check box to the Form.

Syntax

Form.AddCheckBox(X, Y, Text)

Description

Adds a check box to a Form.

Arguments

X {integer}

Represents the horizontal position of the check box on the Form—the position on the 'X-Axis'.

 

Y {integer}

Represents the vertical position of the check box on the Form—the position on the 'Y-Axis'.

 

Text {string}.

Defines the text that is shown next to the check box.

Returns

Check Box Control Object

Check Box Control Objects have common Control Object Properties as well as their own specific properties that can be used in the script (see Check Box Properties).

Example:

Set TurnOn = Form.AddCheckBox(2, 3, "Activate")

This adds a check box to the Form. The check box has the word Activate next to it. The check box returns a Control Object that is stored in the TurnOn variable that is defined earlier in the script.


ClearSCADA 2015 R2