BaseListBoxControl.SelectedItem Property

Gets or sets the currently selected item.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v19.1.dll

Declaration

C#

[Browsable(false)]
public virtual object SelectedItem { get; set; }

VB.NET

<Browsable(False)>
Public Overridable Property SelectedItem As Object

Property Value

Type	Description
Object	An object representing the list box control’s currently selected item.

Remarks

If single selection mode is applied to the list box control (the BaseListBoxControl.SelectionMode property value is set to SelectionMode.One), this property contains the currently selected item. Otherwise, when the control works in a multi-selection mode (the BaseListBoxControl.SelectionMode property is set to SelectionMode.MultiSimple or SelectionMode.MultiExtended), this property value represents the top selected item in the list box control.

If you want to obtain the index of an item currently selected, use the BaseListBoxControl.SelectedIndex property. In addition, you can use the BaseListBoxControl.SelectedValue property to obtain the its value.

Changing the SelectedItem property value at runtime raises the BaseListBoxControl.SelectedIndexChanged and BaseListBoxControl.SelectedValueChanged events.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SelectedItem 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-enable-users-to-design-pivotgridcontrol-format-conditions-at-runtime-t145142/CS/PivotGridFormatCondition/SimpleConditionDesigner.cs#L22

{
    ItemCondition selectedItem = listBoxConditions.SelectedItem as ItemCondition;
    condititonItemControlMain.Init(selectedItem);

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

{
    ItemCondition selectedItem = listBoxConditions.SelectedItem as ItemCondition;
    condititonItemControlMain.Init(selectedItem);

Reporting_data-source-wizard-how-to-customize-the-standard-query-builder-dialog-t333785/CS/ReplaceQueryBuilderSample/FrmQueryBuilder.cs#L15

public string Selected {
    get { return (string)lstTables.SelectedItem; }
    set { lstTables.SelectedItem = value; }

how-to-create-a-custom-editor-that-looks-like-an-iphone-toggle-button-e4569/CS/IPhoneCheckEditSample/Form1.cs#L27

void listBoxControl1_SelectedIndexChanged(object sender, System.EventArgs e) {
    if((sender as ListBoxControl).SelectedItem == null) return;
    defaultLookAndFeel1.LookAndFeel.SkinName = ((sender as ListBoxControl).SelectedItem as SkinContainer).SkinName;

how-to-handle-the-customization-form-field-list-items-click-e2678/CS/WindowsApplication53/Form1.cs#L82

ListBoxControl listBox = sender as ListBoxControl;
PivotCustomizationTreeNodeBase treeNode = listBox.SelectedItem as PivotCustomizationTreeNodeBase;
if (treeNode != null)

VB.NET

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

Private Sub listBoxConditions_SelectedIndexChanged(ByVal sender As Object, ByVal e As EventArgs)
    Dim selectedItem As ItemCondition = TryCast(listBoxConditions.SelectedItem, ItemCondition)
    condititonItemControlMain.Init(selectedItem)

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

Private Sub listBoxConditions_SelectedIndexChanged(ByVal sender As Object, ByVal e As EventArgs)
    Dim selectedItem As ItemCondition = TryCast(listBoxConditions.SelectedItem, ItemCondition)
    condititonItemControlMain.Init(selectedItem)

Reporting_data-source-wizard-how-to-customize-the-standard-query-builder-dialog-t333785/VB/ReplaceQueryBuilderSample/FrmQueryBuilder.vb#L18

Get
    Return CStr(lstTables.SelectedItem)
End Get

how-to-create-a-custom-editor-that-looks-like-an-iphone-toggle-button-e4569/VB/IPhoneCheckEditSample/Form1.vb#L28

Private Sub listBoxControl1_SelectedIndexChanged(ByVal sender As Object, ByVal e As System.EventArgs) Handles listBoxControl1.SelectedIndexChanged
    If (TryCast(sender, ListBoxControl)).SelectedItem Is Nothing Then
        Return

how-to-handle-the-customization-form-field-list-items-click-e2678/VB/WindowsApplication53/Form1.vb#L71

Dim listBox As ListBoxControl = TryCast(sender, ListBoxControl)
Dim treeNode As PivotCustomizationTreeNodeBase = TryCast(listBox.SelectedItem, PivotCustomizationTreeNodeBase)
If treeNode IsNot Nothing Then