Checkbox List Web Control Checkbox List Web Control

Checkbox List Web Control

Zack Cohen Zack Cohen

Overview

A Checkbox list is a repeating component that allows the user to select one or a combination of items from the list. This differs from a radio list in that it is possible to select more than one item from a checkbox list. This differs from a dropdown in the same way.

Airhome-Checkbox-Simple.gif

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:

Airhome-Checkboxes-Simple.png

This checkbox list can easily be created by inserting a Checkbox List. 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 the 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. 

Further Reading

Was this article helpful?

0 out of 0 found this helpful

Add comment

Article is closed for comments.