CheckBox

Checkbox with ToggleMode enabled.

1.0.0

class CheckBoxReckfellSharpInherits Button

Creates a toggle button with left-aligned text. For an independent setting, leave ButtonGroup empty and handle Toggled(bool). A shared ButtonGroup provides mutually exclusive selection and theme-based radio appearance. Use SetPressedNoSignal to load state without handlers, then explicitly refresh dependent UI; in a group this method does not reconcile peers.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

CheckBoxConstructor

# CheckBox

C#
public CheckBox();

Creates a checkbox with ToggleMode = true and left-aligned text. ButtonGroup initially null.

Theme properties

These are Theme resource keys, not C# properties. Use the matching Control GetTheme…() and AddTheme…Override() methods for each value type.

Key and type	Description
`checkbox_checked_color` `Color`	The color of the checked icon when the checkbox is pressed. Default: `Color(1, 1, 1, 1)`
`checkbox_unchecked_color` `Color`	The color of the unchecked icon when the checkbox is not pressed. Default: `Color(1, 1, 1, 1)`
`check_v_offset` `int`	The vertical offset used when rendering the check icons (in pixels). Default: `0`
`checked` `Texture2D`	The check icon to display when the `CheckBox` is checked.
`checked_disabled` `Texture2D`	The check icon to display when the `CheckBox` is checked and is disabled.
`radio_checked` `Texture2D`	The check icon to display when the `CheckBox` is configured as a radio button and is checked.
`radio_checked_disabled` `Texture2D`	The check icon to display when the `CheckBox` is configured as a radio button, is disabled, and is unchecked.
`radio_unchecked` `Texture2D`	The check icon to display when the `CheckBox` is configured as a radio button and is unchecked.
`radio_unchecked_disabled` `Texture2D`	The check icon to display when the `CheckBox` is configured as a radio button, is disabled, and is unchecked.
`unchecked` `Texture2D`	The check icon to display when the `CheckBox` is unchecked.
`unchecked_disabled` `Texture2D`	The check icon to display when the `CheckBox` is unchecked and is disabled.

Reckfell Engine documentationBack to top ↑