| Table of Contents |
Your Content Goes Here
Checkboxes
Checkboxes is the name used to describe an input element that accepts a simple true or false (boolean) state.
To add a Checkbox element, go to Base Types > Checkbox and add it to the canvas.
To add a prebuilt Label / Textbox prebuilt custom type, go to Custom Types > Common: Checkbox | Label or Common: Checkbox_label_textbox and add it to the canvas.
Type of Data Stored
A Checkbox stores a stores a true (checked) or false (unchecked) state.
A Checkbox can only default to unchecked.
Attributes
| Column 1 | Column 2 |
|---|---|
| description |
This is the description of the element used by other modules in the clevr platform. For more information on how description is used, please read this article. The description has more significance for Checkboxes, as the description is also utilized as the label for the checkbox in reports. A description should be placed on all input elements, to allow them to be identifiable in those modules. |
| extend | This is the elementId of a Textbox or Text area that will contain data related to the checkbox. This will often take the form of a textbox beside an “Other” checkbox in a group. Because the checkbox then becomes linked to its extended text input, it becomes easy to include them in reports. |
| disabled |
This will disable the element and prevent modification for all roles, regardless of applied permissions. The disabled attribute should only ever have the value “true” applied. A value of “false” will still make an element disabled. The disabled attribute differs from readonly as it visually greys-out the element to indicate that it is disabled. Utilizing disabled is preferrable to readonly, as it provides visual feedback to the user for why they can’t modify the element. |
| readonly |
This will disable the element and prevent modification for all roles, regardless of applied permissions. The readonly attribute should only ever have the value “true” applied. A value of “false” will still make an element readonly. The readonly attribute differs from disabled as it provides no visual feedback to the user that the element can not be modified. Utilizing disabled is preferrable to readonly, as it provides visual feedback to the user for why they can’t modify the element. |
| shadowId |
This attribute will cause this element to be populated with the value of another element, if the element has never had a value applied in the current record. A value applied to an element, even if blank, will override the value coming from the shadowId. For this reason, we recommend applying the class = “unhook” which will prevent the value from saving its own value. For more details on shadowId, please read this article. |
Other attributes may be applicable to Checkboxes, such as searchable, bulkdataentry, SIS Data Import, and attributes related to Data Tables. Information on the use of those attributes can be found in the applicable lessons.
Import Data
Checkboxes are a restrictive element to Import Data into. Because they store a simple true / false value, the values being provided by your SIS to demographics file must be either the string “true” or “false”. If any other value is provided, it will like represent itself with a checked box when viewing the form, but features such as reports, search/filters, and data exports may behave unexpected or not work at all.
For more information about setting up elements for Import Data, please read the lesson called “SIS and GDI Import” in Level 2.
Compatible Common Functions
The following common function are compatible with with Textboxes:
- maxAllowChecked
- listElementValues
- elementsToArrayOfStrings
- updateCheck