BaseListBoxControl.SelectedIndexChanged Event

Allows you to respond to item selection.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v18.2.dll

Declaration

C#

[DXCategory("Property Changed")]
public event EventHandler SelectedIndexChanged

VB.NET

<DXCategory("Property Changed")>
Public Event SelectedIndexChanged As EventHandler

Event Data

The SelectedIndexChanged event's data class is EventArgs.

Remarks

Handle the SelectedIndexChanged event to perform actions each time the selection has been changed. If the control functions in single selection mode, this event fires after the BaseListBoxControl.SelectedIndex property value has been changed. Usually this happens in the following cases:

• focus moves from one item to another;
• the item that was selected has been removed.

The list box control can, however, function in multi selection mode, allowing several items to be selected. In this case, the SelectedIndexChanged event fires each time the selection has been changed. The indexes of all items currently selected comprise the collection which can be accessed via control’s BaseListBoxControl.SelectedIndices property. The BaseListBoxControl.SelectedIndex property contains the first element in the collection in this case.

Example

The ListBoxControl displays system color names. The following sample code handles the BaseListBoxControl.SelectedIndexChanged event to change the form’s background color to the color whose name is currently selected. The formBkColors hashtable is created for this purpose. Its key is a string representing the system color name. The value, in turn, represents the proper color object. Hence, when a desired color name is selected, the proper color is assigned to the form’s BackColor property.

The image below demonstrates the ListBoxControl‘s look & feel after sample code execution.

C#

// Creates and initializes a new Hashtable.
Hashtable formBkColors = new Hashtable();
// Creates an array containing system colors
Color[] sysColors = {
                           SystemColors.ActiveCaption,
                           SystemColors.ActiveCaptionText,
                           SystemColors.AppWorkspace,
                           SystemColors.Control,
                           SystemColors.ControlDark,
                           SystemColors.ControlLight,
                           SystemColors.ControlText,
                           SystemColors.Desktop,
                           SystemColors.Highlight,
                           SystemColors.InactiveBorder,
                           SystemColors.InactiveCaption,
                           SystemColors.Info,
                           SystemColors.InfoText,
                           SystemColors.Menu,
                           SystemColors.MenuText,
                           SystemColors.ScrollBar,
                           SystemColors.Window,
                           SystemColors.WindowFrame
                        };
// ...
for(int i = 0; i < sysColors.Length; i++){
   // Fills the hashtable
   formBkColors[sysColors[i].Name] = sysColors[i];
   // Populates the ListBoxControl items collection
   listBoxControl1.Items.Add(sysColors[i].Name);
}
private void listBoxControl1_SelectedIndexChanged(object sender, System.EventArgs e) {
   this.BackColor = (Color)formBkColors[(sender as ListBoxControl).Text];
}

VB.NET

' Creates and initializes a new Hashtable.
Dim formBkColors As New Hashtable()
' Creates an array containing system colors
Dim sysColors() As Color = 
  New Color() {SystemColors.ActiveCaption, SystemColors.ActiveCaptionText, _
  SystemColors.AppWorkspace, SystemColors.Control, SystemColors.ControlDark, _
  SystemColors.ControlLight, SystemColors.ControlText, SystemColors.Desktop, _
  SystemColors.Highlight, SystemColors.InactiveBorder, SystemColors.InactiveCaption, _
  SystemColors.Info, SystemColors.InfoText, SystemColors.Menu, SystemColors.MenuText, _
  SystemColors.ScrollBar, SystemColors.Window, SystemColors.WindowFrame}
' ...
Dim i As Integer
For i = 0 To sysColors.Length - 1
   ' Fills the hashtable
   formBkColors(sysColors(i).Name) = sysColors(i)
   ' Populates the ListBoxControl items collection
   ListBoxControl1.Items.Add(sysColors(i).Name)
Next i

Private Sub ListBoxControl1_SelectedIndexChanged(ByVal sender As Object, _
ByVal e As System.EventArgs) Handles ListBoxControl1.SelectedIndexChanged
   Me.BackColor = CType(formBkColors((TryCast(sender, ListBoxControl)).Text), Color)
End Sub

Related GitHub Examples

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

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-custom-font-edit-control-that-supports-a-skinned-font-dialog-e3683/CS/CustomControlBinder.cs#L23

    DependControl.Properties.KeyDown += new System.Windows.Forms.KeyEventHandler(TextEdit_KeyDown);
    InitialControl.SelectedIndexChanged += new EventHandler(ListBoxControl_SelectedIndexChanged);
}

how-to-implement-a-custom-imagecombobox-editor-that-allows-entering-custom-values-e2435/CS/DXSample/MyPopupContainerEdit.cs#L116

base.OnPopupShown();
Properties.ListBox.SelectedIndexChanged += new EventHandler(ListBox_SelectedIndexChanged);
Properties.ListBox.MouseDown += new System.Windows.Forms.MouseEventHandler(ListBox_MouseDown);

XAF_how-to-implement-custom-winpropertyeditor-based-on-the-listboxcontrol-e4890/CS/CustomListBoxPropertyEditor.Module.Win/Editors/CustomListBoxEditor.cs#L27

if(ImmediatePostData)
    listBox.SelectedIndexChanged += listBox_SelectedIndexChanged;
listBox.Items.Clear();

how-to-enable-users-to-design-pivotgridcontrol-format-conditions-at-runtime-t145142/CS/PivotGridFormatCondition/SimpleConditionDesigner.cs#L17

    InitializeComponent();
    listBoxConditions.SelectedIndexChanged += new EventHandler(listBoxConditions_SelectedIndexChanged);
}

how-to-enable-users-to-design-gridview-format-conditions-at-runtime-e3717/CS/GridViewFormatCondition/SimpleConditionDesigner.cs#L23

    InitializeComponent();
    listBoxConditions.SelectedIndexChanged += new EventHandler(listBoxConditions_SelectedIndexChanged);
}

VB.NET

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

    AddHandler DependControl.Properties.KeyDown, AddressOf TextEdit_KeyDown
    AddHandler InitialControl.SelectedIndexChanged, AddressOf ListBoxControl_SelectedIndexChanged
End If

how-to-implement-a-custom-imagecombobox-editor-that-allows-entering-custom-values-e2435/VB/DXSample/MyPopupContainerEdit.vb#L126

MyBase.OnPopupShown()
AddHandler Properties.ListBox.SelectedIndexChanged, AddressOf ListBox_SelectedIndexChanged
AddHandler Properties.ListBox.MouseDown, AddressOf ListBox_MouseDown

XAF_how-to-implement-custom-winpropertyeditor-based-on-the-listboxcontrol-e4890/VB/CustomListBoxPropertyEditor.Module.Win/Editors/CustomListBoxEditor.vb#L33

If ImmediatePostData Then
    AddHandler listBox.SelectedIndexChanged, AddressOf listBox_SelectedIndexChanged
End If

how-to-enable-users-to-design-pivotgridcontrol-format-conditions-at-runtime-t145142/VB/PivotGridFormatCondition/SimpleConditionDesigner.vb#L32

    InitializeComponent()
    AddHandler listBoxConditions.SelectedIndexChanged, AddressOf listBoxConditions_SelectedIndexChanged
End Sub

how-to-enable-users-to-design-gridview-format-conditions-at-runtime-e3717/VB/GridViewFormatCondition/SimpleConditionDesigner.vb#L38

    InitializeComponent()
    AddHandler listBoxConditions.SelectedIndexChanged, AddressOf listBoxConditions_SelectedIndexChanged
End Sub