[Expand]General Information
[Expand]WinForms Controls
[Collapse]ASP.NET Controls and MVC Extensions
 [Expand]Prerequisites
 [Expand]What's Installed
 [Expand]Common Concepts
 [Expand]ASP.NET WebForms Controls
 [Collapse]ASP.NET MVC Extensions
  [Expand]Product Information
  [Expand]Getting Started
  [Expand]Common Concepts
  [Expand]Grid View
  [Expand]Tree List
  [Expand]Card View
   Reporting
  [Expand]Charting
  [Expand]Pivot Grid
   Spreadsheet
   Rich Text Editor
  [Expand]Scheduler
  [Expand]Site Navigation and Layout
  [Expand]HTML Editor
  [Expand]Vertical Grid
  [Collapse]Data Editors
    Editor List
    Main Features
   [Expand]Common Concepts
    BinaryImage
   [Expand]Button
    ButtonEdit
    Calendar
   [Expand]Captcha
    CheckBox
    CheckBoxList
   [Expand]ColorEdit
   [Expand]ComboBox
   [Expand]DateEdit
    DropDownEdit
    Filter Control
    GridLookup
    HyperLink
    Image
    Label
    ListBox
    Memo
   [Expand]ProgressBar
    RadioButton
    RadioButtonList
    SpinEdit
    TextBox
    TimeEdit
    TokenBox
   [Expand]TrackBar
    Validation Summary
   [Expand]Strongly-Typed Editor Types
  [Expand]Docking and Popups
  [Expand]File Management
  [Expand]Data and Image Navigation
  [Expand]Multi-Use Site Extensions
  [Expand]Spell Checker
  [Expand]Query Builder
 [Expand]Localization
 [Expand]Redistribution and Deployment
  Get More Help
 [Expand]API Reference
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]eXpress Persistent Objects
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

CheckBoxList

CheckBoxList represents a list of check boxes that allows the end user to select them.

Expanded Implementation Details

CheckBoxList is realized by the CheckBoxListExtension class. Its instance can be accessed via the ExtensionsFactory.CheckBoxList helper method, which is used to add a CheckBoxList extension to a view. This method's parameter provides access to the CheckBoxList's settings implemented by the CheckBoxListSettings class, allowing you to fully customize the extension.

CheckBoxList's client counterpart is represented by the ASPxClientCheckBoxList object.

Expanded Declaration

CheckBoxList can be added to a view in the following manner.

View code (ASPX):

View code (Razor):

Note

The Partial View should contain only the extension's code.

The code result is demonstrated in the image below.

Expanded Main Features

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.

Expanded Online Demo

Expanded Examples

Is this topic helpful?​​​​​​​