BaseCheckedListBoxControl.CheckedItems Property

Gets the collection of checked item values.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v19.1.dll

Declaration

C#

[Browsable(false)]
public BaseCheckedListBoxControl.CheckedItemCollection CheckedItems { get; }

VB.NET

<Browsable(False)>
Public ReadOnly Property CheckedItems As BaseCheckedListBoxControl.CheckedItemCollection

Property Value

Type	Description
DevExpress.XtraEditors.BaseCheckedListBoxControl.CheckedItemCollection	A CheckedItemCollection object representing the collection of checked item values.

Remarks

The CheckedItems property specifies a collection of the values of checked items. If the ListBox works in unbound mode, an item’s value is specified by the ListBoxItem.Value property. In bound mode, item values are retrieved from the field specified by the BaseListBoxControl.ValueMember property.

The CheckedItems collection is read-only, which means that you cannot add, delete or modify its elements to change an item’s check state.

If you only need to obtain indexes of checked items, use the BaseCheckedListBoxControl.CheckedIndices property.

In unbound mode, to change an item’s check state, use the item’s CheckedListBoxItem.CheckState property. Individual items can be accessed via the control’s BaseCheckedListBoxControl.Items property using index notation.

In bound mode, to access particular items, use the BaseListBoxControl.GetItem method. To get and set an item’s check state, use the BaseCheckedListBoxControl.GetItemChecked, BaseCheckedListBoxControl.GetItemCheckState, BaseCheckedListBoxControl.SetItemChecked and BaseCheckedListBoxControl.SetItemCheckState methods.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CheckedItems property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-get-checked-rows-of-a-data-bound-checkedlistboxcontrol-e722/CS/Form1.cs#L177

string result = "";
foreach(object item in checkedListBoxControl1.CheckedItems) {
    DataRowView row = item as DataRowView;

how-to-prevent-the-popupcontainercontrol-from-being-hidden-e3137/CS/WindowsApplication1/PopupForm.cs#L53

string result = string.Empty;
foreach (object item in checkedListBoxControl1.CheckedItems)
{

Reporting_how-to-list-all-reports-available-in-an-application-t110546/CS/WindowsFormsApplication1/Form1.cs#L31

if (folderBrowserDialog1.ShowDialog() == System.Windows.Forms.DialogResult.OK)
    foreach (CheckedListBoxItem item in checkedListBoxControl1.CheckedItems)
    {

how-to-filter-grid-columns-using-separate-checkedlistboxcontrols-t124162/CS/Form1.cs#L50

{
    items[i] = String.Format("[{0}] = '{1}'", fieldName, filterControl.CheckedItems[i]);
}

how-to-hide-vertical-divider-lines-between-certain-columns-e3647/CS/E3647/Form1.cs#L81

columnList = new List<GridColumn>();
foreach (CheckedListBoxItem item in checkedListBoxControl1.CheckedItems)
    columnList.Add(item.Value as GridColumn);

VB.NET

how-to-get-checked-rows-of-a-data-bound-checkedlistboxcontrol-e722/VB/Form1.vb#L165

Dim result As String = ""
For Each item As Object In checkedListBoxControl1.CheckedItems
    Dim row As DataRowView = TryCast(item, DataRowView)

how-to-prevent-the-popupcontainercontrol-from-being-hidden-e3137/VB/WindowsApplication1/PopupForm.vb#L54

Dim result As String = String.Empty
For Each item As Object In checkedListBoxControl1.CheckedItems
    result &= String.Format("{0}; ", item)

Reporting_how-to-list-all-reports-available-in-an-application-t110546/VB/WindowsFormsApplication1/Form1.vb#L28

If folderBrowserDialog1.ShowDialog() = System.Windows.Forms.DialogResult.OK Then
    For Each item As CheckedListBoxItem In checkedListBoxControl1.CheckedItems
        Dim reportType As Type = System.Reflection.Assembly.GetExecutingAssembly().GetType(item.Value.ToString())

how-to-filter-grid-columns-using-separate-checkedlistboxcontrols-t124162/VB/Form1.vb#L43

For i As Integer = 0 To filterControl.CheckedItems.Count - 1
    items(i) = String.Format("[{0}] = '{1}'", fieldName, filterControl.CheckedItems(i))
Next i

how-to-hide-vertical-divider-lines-between-certain-columns-e3647/VB/E3647/Form1.vb#L78

columnList = New List(Of GridColumn)()
For Each item As CheckedListBoxItem In checkedListBoxControl1.CheckedItems
    columnList.Add(TryCast(item.Value, GridColumn))