Checkbox
- 22 Oct 2020
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Checkbox
- Updated on 22 Oct 2020
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Description
The Checkbox object type defines a Boolean, true or false (yes or no) data element for your app.
When included in a visual layout, a checkable box with a label is displayed and will toggle this underlying value.
Visual Experience
Below is an example of this object's visual experience.
Properties
Properties are accessible directly on the object panel.
| Name | Required | Description |
|---|---|---|
| Display Title | No | Ignored |
| Language | No | Language used when checked |
Settings
Settings are additional properties accessible by clicking the 'Settings' button.
| Name | Required | Description |
|---|---|---|
| Grid - Name | No | Name of grid (objects with same name appear together) |
| Grid - Padding Columns Size | No | Pixel value of space between columns |
| Grid - Padding Rows Size | No | Pixel value of space between rows |
| Grid - Column Size | No | Size of column in pixels (empty will auto-size) |
| Grid - Row Size | No | Size of row in pixels (empty will auto-size) |
| --- | --- | --- |
| Group - Name | No | Name of group within grid (objects with same name appear together) |
| --- | --- | --- |
| Sizing - Width | No | Pixel value of object width (empty for default) |
| Sizing - Height | No | Pixel value of object height (empty for default) |
| Sizing - Margin | No | Margin pixel values (L,T,R,B format) |
| --- | --- | --- |
| Title - Show | No | Whether or not to show object title |
| Title - Underline | No | Whether or not to underline object title |
| Title - Margin | No | Margin pixel values (L,T,R,B format) |
| Title - Foreground | No | Foreground color (#RRGGBB format) |
| --- | --- | --- |
| Alignment - Vertical | No | Vertical alighnment position within container grid cell |
| Alignment - Horizontal | No | Horizontal alighnment position within container grid cell |
| Alignment - Items | No | Alignment orientation for contained items |
| --- | --- | --- |
| Spanning - Column Span | No | # of columns to span in containing grid |
| Spanning - Row Span | No | # of rows to span in containing grid |
| --- | --- | --- |
| Coloring - Background | No | Color of background (#RRGGBB format) |
| Coloring - Foreground | No | Color of foreground (#RRGGBB format) |
| --- | --- | --- |
| Border - Thickness | No | Pixel value of border thickness |
| Border - Color | No | Color of border (#RRGGBB format) |
| --- | --- | --- |
| Migrate | No | Whether or not to migrate values between instances |
Scripting
This object supports an underlying data type accessible to scripts.
Data Type: Boolean
Remarks
None.
Additional Resources