Checkbox

From Xojo Documentation

For web applications, see WebCheckBox.

Class (inherits from RectControl)

The standard checkbox control used by desktop applications.

Events
Action DropObject MouseExit
Close GotFocus MouseMove
ConstructContextualMenu KeyDown MouseUp
ContextualMenuAction KeyUp MouseWheel
DragEnter LostFocus Open
DragExit MouseDown
DragOver MouseEnter
Properties
Active fa-lock-32.png LockBottom TabStop
AutoDeactivate LockLeft TextFont
Bold LockRight TextSize
Caption LockTop Top
DataField MouseCursor Transparent
DataSource MouseX fa-lock-32.png TrueWindow fa-lock-32.png
Enabled MouseY fa-lock-32.png Underline
Handle fa-lock-32.png Name Value
Height PanelIndex Visible
HelpTag Parent Width
Index fa-lock-32.png Scope fa-lock-32.png Window fa-lock-32.png
Italic State
Left TabIndex
Methods
AcceptFileDrop Close RefreshRect
AcceptPictureDrop DrawInto SetBoolean
AcceptRawDataDrop Invalidate SetFocus
AcceptTextDrop Refresh
Enumerations
CheckedStates

Notes

Checkboxes can have three states: CheckBox States.png

fa-info-circle-32.png
The Caption text does not wrap.

Sample Code

The following code in the CheckBox's Action event handler checks the value of the CheckBox:

If CheckBox1.Value Then
TextField1.Text = "True"
Else
TextField1.Text = "False"
End If

Because Checkbox is a three-state control, you can use the State property to get and set its value. The CheckedStates Enumeration is designed to get and set the values.

The following code sets the State property of a Checkbox to Indeterminate.

Checkbox1.State = Checkbox.CheckedStates.Indeterminate

Because State is an Enumeration, you cannot use the corresponding Integer value for comparison. The following code shows how to use State in a Select Case statement:

Select Case CheckBox1.State
Case CheckBox.CheckedStates.Unchecked
// The CheckBox is unchecked

Case CheckBox.CheckedStates.Checked
// The CheckBox is checked

Case CheckBox.CheckedStates.Indeterminate
// The CheckBox state is indeterminate

End Select

See the entries for State and Value for additional examples of setting and getting Checkbox values. See also the CheckedStates Enumeration.

See Also

RadioButton control; RectControl class.