Component/Checkbox

Namespace

Constants

MODULE_COMPONENT_CHECKBOX

67

CHECKBOX_COMPONENT_SET_HIDDEN	0
CHECKBOX_COMPONENT_SET_DISABLED	1
CHECKBOX_COMPONENT_SET_X	2
CHECKBOX_COMPONENT_SET_Y	3
CHECKBOX_COMPONENT_SET_TEXT	4
CHECKBOX_COMPONENT_SET_HINT	5
CHECKBOX_COMPONENT_SET_CHECKED	6
CHECKBOX_COMPONENT_GET_VALUE	7

Properties

These properties can be edited with the property editor in the IDE.

Name	Type	Description
name	string	The component name.
hidden	boolean	Hide the component.
disabled	boolean	Disable the component.
x	number	The left position of the component inside the parent component.
y	number	The top position of the component inside the parent component.
zIndex	number	The depth of the component related to other components in the parent.
text	string	The label text.

Events

onChange

Called when the checkbox is selected or unselected.

proc onChange(number windowHandle, number value)

Name	Type	Description
windowHandle	number	The handle of the parent window of the checkbox.
value	number	`TRUE` when checked, `FALSE` if not checked.

onFocus

Called when the checkbox is focussed.

proc onFocus(number windowHandle)

Name	Type	Description
windowHandle	number	The handle of the parent window of the checkbox.

onBlur

Called when the checkbox looses focus.

proc onBlur(number windowHandle)

Name	Type	Description
windowHandle	number	The handle of the parent window of the checkbox.

---

Procedures

setHidden

Hide the checkbox.

proc setHidden(number windowHandle, number componentHandle, number hidden)

Name	Type	Description
windowHandle	number	The handle of the window.
componentHandle	number	The handle of the component.
hidden	number	Hidden TRUE or FALSE.

---

setDisabled

Disable the checkbox.

proc setDisabled(number windowHandle, number componentHandle, number disabled)

Name	Type	Description
windowHandle	number	The handle of the window.
componentHandle	number	The handle of the component.
disabled	number	Disabled TRUE or FALSE.

---

setX

Set the x position of the checkbox.

proc setX(number windowHandle, number componentHandle, number x)

Name	Type	Description
windowHandle	number	The handle of the window.
componentHandle	number	The handle of the component.
x	number	The x position in pixels.

---

setY

Set the y position of the checkbox.

proc setY(number windowHandle, number componentHandle, number y)

Name	Type	Description
windowHandle	number	The handle of the window.
componentHandle	number	The handle of the component.
y	number	The y position in pixels.

---

setText

Set the checkbox text.

proc setText(number windowHandle, number componentHandle, string text)

Name	Type	Description
windowHandle	number	The handle of the window.
componentHandle	number	The handle of the component.
text	string	The checkbox label text.

---

setHint

Set the checkbox hint.

proc setHint(number windowHandle, number componentHandle, string hint)

Name	Type	Description
windowHandle	number	The handle of the window.
componentHandle	number	The handle of the component.
hint	string	The checkbox hint.

---

setChecked

Set the checkbox value.

proc setChecked(number windowHandle, number componentHandle, number checked)

Name	Type	Description
windowHandle	number	The handle of the window.
componentHandle	number	The handle of the component.
checked	number

---

getValue

Get the value.

proc getValue(number windowHandle, number componentHandle)

Name	Type	Description
windowHandle	number	The handle of the window.
componentHandle	number	The handle of the component.

---