> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Checkbox

> Checkbox

Adds a checkbox to your screen.

## Configuration

| Setting     | Description                                                           |
| :---------- | :-------------------------------------------------------------------- |
| label       | UI label, displayed to the left of the box                            |
| suffixLabel | Optional description, displayed to the right of the box               |
| warning     | Adds a warning message<br />Shown in a pop-up when the box is checked |

## Functions

### setValue(String isSelected)

Marks the checkbox as selected ("1") or unselected ("0").

### toBool()

Returns the value of the checkbox as a Bool, true or false.

### toString()

Returns the value of the checkbox as a string, "1" or "0".


## Related topics

- [EventDataDialogDefinition](/en/automation/crmscript/reference/CRMScript.Native.EventDataDialogDefinition.md)
- [Change Completed status of an activity](/en/diary/learn/change-completed-status.md)
- [Reference](/en/customization/screen-designer/admin/reference.md)
- [Look at recipient list after the mailing](/en/marketing/recipients/learn/look-at-recipient-list.md)
- [Enum ConfigFieldType](/en/api/plugins/quote-connectors/api/enums/configfieldtype.md)
- [SuperOffice.WebApi.Data.UDefFieldType](/en/api/reference/webapi/SuperOffice.WebApi.Data.UDefFieldType.md)
- [Edit user-defined field](/en/custom-objects/admin/edit-udef.md)