ASPxCheckBoxList Class

A control to display a list of check boxes.

Assembly: DevExpress.Web.v23.2.dll

Declaration

C#
VB.NET

public class ASPxCheckBoxList :
    ASPxCheckListBase,
    IMultiSelectListEdit

Public Class ASPxCheckBoxList
    Inherits ASPxCheckListBase
    Implements IMultiSelectListEdit

Remarks

The ASPxCheckBoxList is a control that displays a list of check boxes which can be selected by end-users.

CheckBoxList_view

Create a Check Box List

Design Time

The ASPxCheckBoxList control is available on the DX.23.2: Common Controls toolbox tab in the Microsoft Visual Studio IDE.

Drag the control onto a form and customize the control’s settings, or paste the control’s markup in the page’s source code.

ASPX

<dx:ASPxCheckBoxList ID="checkBoxList" runat="server" RepeatDirection="Horizontal">
    <Items>
        <dx:ListEditItem Text="Item 1" Value="1" />
        <dx:ListEditItem Text="Item 2" Value="2" />
        <dx:ListEditItem Text="Item 3" Value="3" />
    </Items>
</dx:ASPxCheckBoxList>

using DevExpress.Web;
...
protected void Page_Load(object sender, EventArgs e)
{
    ASPxCheckBoxList checkBoxList = new ASPxCheckBoxList();
    checkBoxList.ID = "checkBoxList";
    Page.Form.Controls.Add(checkBoxList);

    checkBoxList.RepeatDirection = RepeatDirection.Horizontal;
    checkBoxList.Items.AddRange(new List<ListEditItem>() {
        new ListEditItem("Item 1", 1),
        new ListEditItem("Item 2", 2),
        new ListEditItem("Item 3", 3)
    });
}

Imports DevExpress.Web

Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
    Dim checkBoxList As ASPxCheckBoxList = New ASPxCheckBoxList()
    checkBoxList.ID = "checkBoxList"
    Page.Form.Controls.Add(checkBoxList)

    checkBoxList.RepeatDirection = RepeatDirection.Horizontal
    checkBoxList.Items.AddRange(New List(Of ListEditItem)() From {
        New ListEditItem("Item 1", 1),
        New ListEditItem("Item 2", 2),
        New ListEditItem("Item 3", 3)
    })
End Sub

Note

DevExpress controls require that you register special modules, handlers, and options in the Web.config file. You can change this file or switch to the Design tab in the Microsoft Visual Studio IDE to automatically update the Web.config file. Note that this information is automatically registered if you use the DevExpress Template Gallery to create a project.

The ASPxCheckBoxList editor’s item list can be generated dynamically through data binding or populated manually. In order to bind the ASPxCheckBoxList to a data source, use the DataSourceID (DataSource) property. When retrieving items from the data source, item characteristics such as the text, value, and image are obtained from specific data fields defined via the ASPxListEdit.TextField, ASPxListEdit.ValueField and ASPxListEdit.ImageUrlField properties.

List items are contained within the editor’s ASPxListEdit.Items collection. You can define the caption text (ListEditItem.Text), associated value (ListEditItem.Value), and display image (ListEditItem.ImageUrl) for an individual item. Note, for the ASPxCheckBoxList editor to function properly, values of all list items in the ASPxListEdit.Items collection should be unique. There should not be two or more list items with the same value of the ListEditItem.Value property. The control’s ASPxCheckBoxList.Value property specifies a value of a selected item (if only one item is selected) or a value of the first selected item (if multiple items are selected).

You can get an array of selected items using the ASPxCheckBoxList.SelectedItems property, or you can access arrays of indices (ASPxCheckBoxList.SelectedIndices) or values (ASPxCheckBoxList.SelectedValues) of selected items. Methods provided by the ASPxCheckBoxList allow you to select (ASPxCheckBoxList.SelectAll) or unselect (ASPxCheckBoxList.UnselectAll) all items within the control.

You can display the ASPxCheckBoxList‘s data in several columns (ASPxCheckListBase.RepeatColumns), set a direction of items within the control (ASPxCheckListBase.RepeatDirection), and specify whether items are aligned as a table (ASPxCheckListBase.RepeatLayout).

To customize the control appearance style, use the ASPxCheckBoxList.CheckBoxStyle and ASPxCheckBoxList.CheckBoxFocusedStyle properties. You can change the default check box images using the ASPxCheckBoxList.CheckedImage and ASPxCheckBoxList.UncheckedImage properties.

Note

The client-side equivalent of this editor control is the ASPxClientCheckBoxList object. The editor’s client-side API is enabled if the ASPxEditBase.EnableClientSideAPI property is set to true, or the ASPxEditBase.ClientInstanceName property is specified, or any client event is handled. Available client events can be accessed via the ASPxCheckListBase.ClientSideEvents property.