ListBoxControl.Items Property

Provides access to the item collection, when the control is not bound to a data source.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v19.2.dll

Declaration

C#

[DXCategory("Data")]
public virtual ListBoxItemCollection Items { get; }

VB.NET

<DXCategory("Data")>
Public Overridable ReadOnly Property Items As ListBoxItemCollection

Property Value

Type	Description
ListBoxItemCollection	A ListBoxItemCollection object representing items within the list box control.

Remarks

When the control is not bound to a data source, use the Items property to access the control’s item collection. You can add, remove and access items using index notation. Each item is represented by the ListBoxItem object.

To improve the control’s performance while performing multiple changes on the item collection, use the ListBoxItemCollection.BeginUpdate/ListBoxItemCollection.EndUpdate methods

When the control is bound to a data source via the BaseListBoxControl.DataSource property, the Items collection is always empty. In this instance, to access particular items, use the BaseListBoxControl.GetItem method.

Example

The following sample code initializes the myColors array of strings representing system color names. Then, if no external data source is assigned to the control, the ListBoxControl‘s item collection is populated with myColors elements.

C#

// Initialize an array of strings representing system colors names
string[] myColors = {
                        Color.Black.Name,
                        Color.Blue.Name,
                        Color.Brown.Name,
                        Color.Green.Name,
                        Color.Red.Name,
                        Color.Yellow.Name,
                        Color.Orange.Name
                     };
// Check whether an external data source is assigned to the ListBox
if (listBoxControl1.DataSource == null)
   // add items to the ListBox. 
   listBoxControl1.Items.AddRange(myColors);

VB.NET

' Initialize an array of strings representing system colors names
Dim myColors() As String = New String() {Color.Black.Name, Color.Blue.Name, Color.Brown.Name, _
    Color.Green.Name, Color.Red.Name, Color.Yellow.Name, Color.Orange.Name}
' Check whether an external data source is assigned to the ListBox
If ListBoxControl1.DataSource Is Nothing Then
   ' add items to the ListBox. 
   ListBoxControl1.Items.AddRange(myColors)
End If

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Items 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-obtain-active-filter-criteria-applied-to-pivotgridcontrols-fields-e1999/CS/WindowsApplication1/Form1.cs#L30

    pivotGridControl1.DataSource = CreateTable(150);
    new MyPivotGridFilterHelper(pivotGridControl1, listBoxControl2.Items, listBoxControl1.Items);
}

how-to-drag-drop-listboxcontrol-items-between-listboxcontrols-unbound-mode-e704/CS/Form1.cs#L143

int selectedIndex = listBox.IndexFromPoint(newPoint);
object item = listBoxControl1.Items[listBoxControl1.IndexFromPoint(p)];
if (selectedIndex == -1)

how-to-implement-a-custom-menu-for-filtercontrol-e3457/CS/CustomFilterControlPopupMenu/CustomMenuManager.cs#L50

void OnPopupCloseUp(object sender, EventArgs e) {
    foreach (IDisposable d in ListBox.Items)
        d.Dispose();

VB.NET

how-to-obtain-active-filter-criteria-applied-to-pivotgridcontrols-fields-e1999/VB/WindowsApplication1/Form1.vb#L29

    pivotGridControl1.DataSource = CreateTable(150)
    Dim TempMyPivotGridFilterHelper As MyPivotGridFilterHelper = New MyPivotGridFilterHelper(pivotGridControl1, listBoxControl2.Items, listBoxControl1.Items)
End Sub

how-to-drag-drop-listboxcontrol-items-between-listboxcontrols-unbound-mode-e704/VB/Form1.vb#L141

Dim selectedIndex As Integer = listBox.IndexFromPoint(newPoint)
Dim item As Object = listBoxControl1.Items(listBoxControl1.IndexFromPoint(p))
If selectedIndex = -1 Then