CheckBoxList Main Features
- 2 minutes to read
The CheckBoxList editor is a check box group that provides end-users with the ability to select multiple items.
The CheckBoxList supports both data-bound and unbound modes. This means that its contents can be generated dynamically by binding the editor to a data source, as well as manually populating the control’s item collection.
Selection
The items selected within CheckBoxList can be determined by iterating through all list items and inspecting an item’s ListEditItem.Selected property, or by using specific properties declared at the editor level (ASPxCheckBoxList.SelectedItems, ASPxCheckBoxList.SelectedIndices, ASPxCheckBoxList.SelectedValues). You can easily select/unselect all editor items by using the SelectAll/UnselectAll methods that are available on both server (ASPxCheckBoxList.SelectAll/ASPxCheckBoxList.UnselectAll) and client (ASPxClientCheckBoxList.SelectAll/ASPxClientCheckBoxList.UnselectAll) sides.
Layout Customization
The CheckBoxList layout is flexibly customized. You can display check box items in several columns using the CheckBoxListSettings.Properties.RepeatColumns (CheckListPropertiesBase.RepeatColumns), set a direction of items within the editor (horizontal or vertical through the CheckBoxListSettings.Properties.RepeatDirection (CheckListPropertiesBase.RepeatDirection) property), and specify whether items are aligned within a table or rendered without any table structure using the CheckBoxListSettings.Properties.RepeatLayout (CheckListPropertiesBase.RepeatLayout).
Custom Item Images
The CheckBoxList editor allows you to specify images for its items. You can specify one image for all items within the control using the CheckBoxListSettings.Properties.ItemImage (ASPxCheckListBase.ItemImage) property, or set a particular image for each item using the item’s CheckBoxListSettings.Properties.ImageUrl (ListEditItem.ImageUrl) property.
Online Demo
Refer to the Check Box List online demo to see this editor in action.
Examples
How to use the CheckBoxList and RadioButtonList editors to edit Model fields
CheckBoxList - How to emulate RadioButtonList that allows users to unselect items