You are here:
Checkbox Control
The Checkbox Control element defines a checkbox UI control that can have a label and the user can select (check) or clear (uncheck).
Required Editions
| Available in: Enterprise, Performance, and Unlimited Editions |
The table lists the Checkbox element attributes.
| Attribute | Description | Value or Pattern | Validation |
|---|---|---|---|
| name | Identification of this Checkbox | String | yes |
| disabled | Indicates whether this control is enabled. If this attribute is used, all edit and access rights configurations that control the access to this UI element are suspended. | boolean | no |
The Checkbox element contains these sub-elements.
- Resource
- Bindings
CheckboxControl Resource node
The CheckboxControl Resource node consists of Resource elements that can be used in the CheckboxControl element.
| Attribute | Description | Value or Pattern |
|---|---|---|
| target | Describes the actual UI element. | string [RootLabel] |
| type | Defines how the resource is shown. | string [Label] |
| Id | The ID is used to map the localized resource and the actual element in the UI. | string |
| defaultLabel | One default value can be set, depending on the type, that is, defaultText, defaultLabel, and defaultImage. | string |
| bindingMode | Only applies if type = Label. Determines whether a long line of text is wrapped (true) or trimmed (false). | string [One Way] |
CheckboxControl Bindings node
The CheckboxControl Bindings node consists of Binding elements that can be used in the Checkbox Control element.
| Attribute | Description | Value or Pattern |
|---|---|---|
| target | Describes the actual UI element. | String[checkedValue] |
| binding | Source of the binding. | string[valueBinding] |
| bindingMode | Binding mode is used to control the updating process. | string [One Way] |
Did this article solve your issue?
Let us know so we can improve!

