Skip to content

guicheckboxctrl: members

13 implemented, 0 reserved. Entries are sorted by name.

guicheckboxctrl.buttontype: string

Runs on: client only. Origin: compatibility. Since: M14. Playground: no.

How the button behaves when clicked: pushbutton, togglebutton or radiobutton.

new GuiCheckBoxCtrl("MyControl") { buttontype = "togglebutton"; }

Specification: gui-legacy.md§29.

guicheckboxctrl.checked: boolean

Runs on: client only. Origin: compatibility. Since: M14. Playground: no.

Whether a toggle or radio button is checked (another name of value on a check box or radio control).

echo(MyControl.checked);

Specification: gui-legacy.md§29.

guicheckboxctrl.gettext() -> string

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

The text of a text edit or markup text control, as stored.

echo(Edit.getText());

Specification: gui.md§3.

guicheckboxctrl.getvalue() -> any

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

The value of a check box, radio button, slider, progress bar, number input, or the text of a text edit.

echo(Box.getValue());

Specification: gui.md§3.

guicheckboxctrl.groupnum: number

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

The group of a radio-type button: choosing one clears the others of its group.

new GuiRadioCtrl("MyControl") { groupnum = 10; }

Specification: gui.md§3.

guicheckboxctrl.icon: string

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Property of GuiCheckBoxCtrl in the legacy GUI toolkit (gui.md§2, §3).

new GuiCheckBoxCtrl("MyControl") { icon = 1; }

Specification: gui.md§3.

guicheckboxctrl.iconheight: number

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Property of GuiCheckBoxCtrl in the legacy GUI toolkit (gui.md§2, §3).

new GuiCheckBoxCtrl("MyControl") { iconheight = 1; }

Specification: gui.md§3.

guicheckboxctrl.iconwidth: number

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Property of GuiCheckBoxCtrl in the legacy GUI toolkit (gui.md§2, §3).

new GuiCheckBoxCtrl("MyControl") { iconwidth = 1; }

Specification: gui.md§3.

guicheckboxctrl.settext(text: string) -> number

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Replaces the text of a text edit; the caret goes to the end.

Edit.setText("hello");

Specification: gui.md§3.

guicheckboxctrl.setvalue(value: any) -> number

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Sets the value of a check box, radio button, or slider without raising onAction.

Box.setValue(true);

Specification: gui.md§3.

guicheckboxctrl.stylesection: string

Runs on: client only. Origin: compatibility. Since: M14. Playground: no.

Name of the part of the GUI style the control takes its colors from; kept without GUI styles.

new GuiCheckBoxCtrl("MyControl") { stylesection = "Clock"; }

Specification: gui.md§3.11.

guicheckboxctrl.text: string

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

The text the control shows.

new GuiCheckBoxCtrl("MyControl") { text = "Hello"; }

Specification: gui.md§3.

guicheckboxctrl.value: boolean

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

The current value.

new GuiCheckBoxCtrl("MyControl") { value = 1; }

Specification: gui.md§3.

Engine version 0.1.0. Built 2026-11-18.