BaseListBoxControl.SelectedIndex Property

Gets or sets the index of the currently selected item.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v19.2.dll

Declaration

C#

[Browsable(false)]
public virtual int SelectedIndex { get; set; }

VB.NET

<Browsable(False)>
Public Overridable Property SelectedIndex As Integer

Property Value

Type	Description
Int32	An integer value representing the zero-based index of the item in the list box control. -1 if no item is selected.

Remarks

If single-selection mode is applied to the list box control (the BaseListBoxControl.SelectionMode property value is set to SelectionMode.One), this property holds the index of the currently selected item. Otherwise, if the control is in multi-select mode (the BaseListBoxControl.SelectionMode property value is set either to SelectionMode.MultiSimple or SelectionMode.MultiExtended), indexes of all currently selected items represent the collection which can be accessed via BaseListBoxControl.SelectedIndices property. In this instance, the SelectedIndex property contains the first element in BaseListBoxControl.SelectedIndices.

If you want to obtain the currently selected item, use the BaseListBoxControl.SelectedItem property. In addition, use the BaseListBoxControl.SelectedValue property to obtain the value of the currently selected item.

Changing the SelectedIndex property value raises the BaseListBoxControl.SelectedIndexChanged and BaseListBoxControl.SelectedValueChanged events.

Note: setting the SelectedIndex property to a value greater than the number of items immediately sets it to the last item’s index.

Example

The following sample code declares a DeleteItems method accepting two parameters:

• listBoxControl - a ListBoxControl;
• index - the index of an item after which all items are to be removed.

Use this method to delete all items from the ListBoxControl items collection that are next to the specified one. If the listBoxControl parameter points to a non-existent control or the index parameter points either to the non-existent control or the last item in the collection, method execution will not take place.

Note: if the control specified by the listBoxControl parameter is bound to a data source, method execution will not take place.

C#

private void DeleteItems(ListBoxControl listBox, int index){
   int count = listBox.ItemCount;
   if (index < listBox.ItemCount - 1)
      for (int i = index + 1; i < count; i ++)
         listBox.Items.RemoveAt(index + 1);
}
// ...
// Deletes all items from the ListBoxControl collection after the selected one
DeleteItems(listBoxControl1, listBoxControl1.SelectedIndex);

VB.NET

Private Sub DeleteItems(ByVal listBox As ListBoxControl, ByVal index As Integer)
   Dim count As Integer
   Dim i As Integer
   count = listBox.ItemCount
   If index < listBox.ItemCount - 1 Then
      For i = index + 1 To count - 1
         listBox.Items.RemoveAt(index + 1)
      Next i
   End If
End Sub
' ...
' Deletes all items from the ListBoxControl collection after the selected one
DeleteItems(ListBoxControl1, ListBoxControl1.SelectedIndex)

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SelectedIndex 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-create-a-text-editor-to-show-auto-completion-suggestions-in-the-popup-e3055/CS/TextEditPopUp/RepositoryItemTextEditPopUp.cs#L105

// Arrow up key
if (lb.SelectedIndex > 0)
    lb.SelectedIndex--;

how-to-handle-the-hyperlink-click-event-t437501/CS/HyperlinkClickExample/Forms/SelectProductForm.cs#L28

    if (list.Count > 0)
        this.listBoxControl.SelectedIndex = 0;
}

Reporting_how-to-override-the-newreport-command-in-the-end-user-designer-e1291/CS/XtraForm1.cs#L24

private void ReportChooser_Load(object sender, EventArgs e) {
    this.listBoxControl1.SelectedIndex = 0;
}

Reporting_embedded-end-user-report-designer-demonstration-e20017/CS/Contacts/Controls/PersonControl.cs#L207

{
    if (checkedList.SelectedIndex > -1)
    {

how-to-create-a-custom-font-edit-control-that-supports-a-skinned-font-dialog-e3683/CS/CustomControlBinder.cs#L65

{
    currentListBox.SelectedIndex = iSelectedIndex;
}

VB.NET

how-to-create-a-text-editor-to-show-auto-completion-suggestions-in-the-popup-e3055/VB/TextEditPopUp/RepositoryItemTextEditPopUp.vb#L107

' Arrow up key
If lb.SelectedIndex > 0 Then
    lb.SelectedIndex -= 1

how-to-handle-the-hyperlink-click-event-t437501/VB/HyperlinkClickExample/Forms/SelectProductForm.vb#L39

If list.Count > 0 Then
    Me.listBoxControl.SelectedIndex = 0
End If

Reporting_how-to-override-the-newreport-command-in-the-end-user-designer-e1291/VB/XtraForm1.vb#L31

Private Sub ReportChooser_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
    Me.listBoxControl1.SelectedIndex = 0
End Sub

Reporting_embedded-end-user-report-designer-demonstration-e20017/VB/Contacts/Controls/PersonControl.vb#L212

Private Sub buttonDelete_Click(ByVal sender As Object, ByVal e As EventArgs) Handles buttonDelete.Click
    If checkedList.SelectedIndex > -1 Then
        Categories(checkedList.SelectedIndex).Delete()

how-to-create-a-custom-font-edit-control-that-supports-a-skinned-font-dialog-e3683/VB/CustomControlBinder.vb#L59

If iSelectedIndex >= 0 AndAlso iSelectedIndex < currentListBox.Items.Count Then
    currentListBox.SelectedIndex = iSelectedIndex
End If