Overview
A Checkbox List is a repeating component that allows the user to select one or a combination of items from a list. This differs from a Radio List and a Dropdown in that it is possible to select more than one item from a Checkbox List.
Control Details
Value
This is the list of selected options from the checkbox list.
Data
This is the list of data. Each item in the list will have its own item in the Checkbox.
Value Text
If provided, this is the value stored in the selected objects array, provided in the Selected argument. The entire item will be stored in the list when selected if not provided.
Selected
This expression is executed on each item in the list to determine whether it is currently selected.
Item Name
By default: item This property is used within the context of the checkbox cell as the current item in the cell.
Index Name
By default: index This is the number value of the current index of the current item. Visible within the context of the checkbox cell.
Collection Name
By default: items This is a variable referring to the entire collection of objects. With the default values set up, items[index] = item
Checkbox Cell
Checkbox Cell is the default container with a checkbox cell and is part of the Checkbox List. Within the Checkbox Cell, the selected item can populate the information to the user. If a Checkbox Control is placed within the Checkbox Cell, it will be selected when it passes the selected criteria on the Checkbox List Web Component.
Examples
Example 1: Simple Checkbox
A simple Checkbox with a Label:
This list can be created by inserting a Checkbox List and setting the Value of the list to a List of selected objects (in this case, houses). In the Data Binding section, set the Data to the collection. Set Selected to CONTAINS(selected_houses, item) where selected houses are the list of items to be selected, and the item is the current item in the list.
This default example will take care of the selection. No additional properties are required on the Checkbox Cell, nor are any actions needed to maintain the selection. The Checkbox List will maintain it.