CheckedItems Property

Returns a collection which contains the ValueListItem instances whose CheckState property returns 'Checked'.

Syntax

Visual Basic

'Declaration
 
Public ReadOnly Property CheckedItems As CheckedValueListItemsCollection

C#

public CheckedValueListItemsCollection CheckedItems {get;}

Remarks

Items whose CheckState property returns 'Indeterminate' are not included in the CheckedItems collection.

The CheckedItems property is similar to the property of the same name exposed by the .NET CheckedListBox control.

When the EditorWithCombo's EditorValueSource property is set to 'CheckedItems', the editor's value consists of a list containing the DataValue of each checked item; the CheckedItems collection returns a list of the same size, but which includes references to those items as opposed to their values.

Example

The following code sample demonstrates how to use the CheckedItems collection to determine whether an item with a particular value is checked:

Visual Basic

Imports Infragistics.Win
Imports Infragistics.Win.UltraWinEditors
Imports System.Diagnostics

	Public Function IsItemChecked(ByVal comboEditor As UltraComboEditor, ByVal dataValue As Object) As Boolean

        Dim checkedItems As CheckedValueListItemsCollection = comboEditor.CheckedItems

        '  Iterate the CheckedItems collection and compare the value
        '  of each item therein to the specified value.
        Dim item As ValueListItem
        For Each item In checkedItems

            If Object.Equals(dataValue, item.DataValue) Then Return True
        Next

        Return False

	End Function

C#

using Infragistics.Win;
using Infragistics.Win.UltraWinEditors;
using System.Diagnostics;

public bool IsItemChecked( UltraComboEditor comboEditor, object dataValue )
{
    CheckedValueListItemsCollection checkedItems = comboEditor.CheckedItems;

    //  Iterate the CheckedItems collection and compare the value
    //  of each item therein to the specified value.
    foreach( ValueListItem item in checkedItems )
    {
        if ( object.Equals(dataValue, item.DataValue) )
            return true;
    }

    return false;
}

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2