Back to Devexpress

BaseListBoxControl.SelectedItem Property

windowsforms-devexpress-dot-xtraeditors-dot-baselistboxcontrol-daa9a2c3.md

latest7.7 KB
Original Source

BaseListBoxControl.SelectedItem Property

Gets or sets the currently selected item.

Namespace : DevExpress.XtraEditors

Assembly : DevExpress.XtraEditors.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
[Browsable(false)]
public virtual object SelectedItem { get; set; }
vb
<Browsable(False)>
Public Overridable Property SelectedItem As Object

Property Value

TypeDescription
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.

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.

dashboard-constant-lines/CS/ConstantLineExtension.Win/ConstantLineDialog.cs#L64

csharp
private void btn_Remove_Click(object sender, EventArgs e) {
    customConstantLines.Remove(listBoxControl1.SelectedItem as CustomConstantLine);
    if(listBoxControl1.SelectedItem == null && customConstantLines.Count != 0)

reporting-crosstab-customization/CS/CrosstabControlCustomizationExample/Form1.cs#L40

csharp
object selectedItem = listBoxControl1.SelectedItem;
if (selectedItem != null && listBoxControl1.Items.Contains(selectedItem))

how-to-handle-diagramcontrol-events-to-save-diagrams-to-a-database-instead-of-a-file-system-t360920/CS/XtraDiagram.CustomDiagramStorage/DiagramOpenDialog.cs#L42

csharp
protected virtual void OnSelectedItemChanged() {
    SelectedItem = listBoxControl1.SelectedItem as string;
}

winforms-charts-create-model-for-custom-chart-element/CS/CustomChartElementModel/CustomColorizerEditor.cs#L36

csharp
if (value == null || listBox.SelectedItem.GetType() != value.GetType())
    return listBox.SelectedItem;
else

winforms-dashboard-apply-conditional-formatting-to-grid-cells/CS/Dashboard_ConditionalFormatting_Grid/StartForm.cs#L17

csharp
private void OpenForm() {
    CFRules demo = (CFRules)listBoxControl1.SelectedItem;
    switch (demo) {

reporting-crosstab-customization/VB/CrossTabControlCustomizationExample/Form1.vb#L40

vb
Dim selectedItem As Object = listBoxControl1.SelectedItem
If selectedItem IsNot Nothing AndAlso listBoxControl1.Items.Contains(selectedItem) Then

how-to-handle-diagramcontrol-events-to-save-diagrams-to-a-database-instead-of-a-file-system-t360920/VB/XtraDiagram.CustomDiagramStorage/DiagramOpenDialog.vb#L40

vb
Protected Overridable Sub OnSelectedItemChanged()
    SelectedItem = TryCast(listBoxControl1.SelectedItem, String)
End Sub

winforms-charts-create-model-for-custom-chart-element/VB/CustomChartElementModel/CustomColorizerEditor.vb#L38

vb
If value Is Nothing OrElse listBox.SelectedItem.GetType() IsNot value.GetType() Then
    Return listBox.SelectedItem
Else

winforms-dashboard-apply-conditional-formatting-to-grid-cells/VB/Dashboard_ConditionalFormatting_Grid/StartForm.vb#L17

vb
Private Sub OpenForm()
    Dim demo As CFRules = CType(listBoxControl1.SelectedItem, CFRules)
    Select Case demo

See Also

GetItem(Int32)

SelectedIndex

SelectedIndexChanged

SelectedIndices

SelectedItems

SelectedValue

SelectedValueChanged

BaseListBoxControl Class

BaseListBoxControl Members

DevExpress.XtraEditors Namespace