windowsforms-devexpress-dot-xtraeditors-dot-baselistboxcontrol-cc4aa7a9.md
Gets or sets the data source that provides items to display in the control.
Namespace : DevExpress.XtraEditors
Assembly : DevExpress.XtraEditors.v25.2.dll
NuGet Package : DevExpress.Win.Navigation
[DefaultValue(null)]
[DXCategory("Data")]
public virtual object DataSource { get; set; }
<DefaultValue(Nothing)>
<DXCategory("Data")>
Public Overridable Property DataSource As Object
| Type | Default | Description |
|---|---|---|
| Object | null |
A data source object whose data is displayed by the ListBox control.
|
Use the DataSource property to bind the control to a data source and thus display data source records as listbox items. The data source can be any object implementing the IList or IListSource interface. Changing the DataSource property value at runtime raises the BaseListBoxControl.DataSourceChanged event.
The following properties can be additionally customized:
To retrieve listbox items in bound mode, use the BaseListBoxControl.GetItem method.
To populate the ListBox control in unbound mode, add items to the control’s Items collection (ListBoxControl.Items, BaseCheckedListBoxControl.Items or BaseImageListBoxControl.Items).
The code below shows how to use a DataTable as a data source.
using DevExpress.XtraEditors;
listBoxControl1.DataSource = GetCountries();
listBoxControl1.DisplayMember = "Name";
listBoxControl1.ValueMember = "PhoneCode";
listBoxControl1.SelectedValueChanged += ListBoxControl1_SelectedValueChanged;
private void ListBoxControl1_SelectedValueChanged(object sender, EventArgs e) {
var listBoxControl = sender as ListBoxControl;
XtraMessageBox.Show(listBoxControl.SelectedValue.ToString());
}
DataTable GetCountries() {
DataTable table = new DataTable();
DataColumn name = new DataColumn("Name", typeof(string));
DataColumn phoneCode = new DataColumn("PhoneCode", typeof(int));
table.Columns.AddRange(new DataColumn[] { name, phoneCode});
table.Rows.Add(new object[] { "United States", 1 });
table.Rows.Add(new object[] { "Afghanistan", 93 });
// ...
table.Rows.Add(new object[] { "Zimbabwe", 263 });
return table;
}
Imports DevExpress.XtraEditors
listBoxControl1.DataSource = GetCountries()
listBoxControl1.DisplayMember = "Name"
listBoxControl1.ValueMember = "PhoneCode"
AddHandler listBoxControl1.SelectedValueChanged, AddressOf ListBoxControl1_SelectedValueChanged
Private Sub ListBoxControl1_SelectedValueChanged(ByVal sender As Object, ByVal e As EventArgs)
Dim listBoxControl = TryCast(sender, ListBoxControl)
Call XtraMessageBox.Show(listBoxControl.SelectedValue.ToString())
End Sub
Private Function GetCountries() As DataTable
Dim table As DataTable = New DataTable()
Dim name As DataColumn = New DataColumn("Name", GetType(String))
Dim phoneCode As DataColumn = New DataColumn("PhoneCode", GetType(Integer))
table.Columns.AddRange(New DataColumn() {name, phoneCode})
table.Rows.Add(New Object() {"United States", 1})
table.Rows.Add(New Object() {"Afghanistan", 93})
' ...
table.Rows.Add(New Object() {"Zimbabwe", 263})
Return table
End Function
The code below uses the ValueMember and DisplayMember properties to specify data fields that contain a business object’s value and string representation. If you do not specify these properties, the control uses the business object as a value and the ToString() method to obtain the object’s string representation.
using DevExpress.XtraEditors;
listBoxControl1.DataSource = Country.Countries;
listBoxControl1.DisplayMember = "Name";
listBoxControl1.ValueMember = "PhoneCode";
listBoxControl1.SelectedValueChanged += ListBoxControl1_SelectedValueChanged;
private void ListBoxControl1_SelectedValueChanged(object sender, EventArgs e) {
var listBoxControl = sender as ListBoxControl;
XtraMessageBox.Show(listBoxControl.SelectedValue.ToString());
}
public class Country {
public string Name { get; set; }
public int PhoneCode { get; set; }
public override string ToString() {
return $"{Name}, {PhoneCode}";
}
public static Country[] Countries = (new Country[] {
new Country() { Name = "United States", PhoneCode = 1 },
new Country() { Name = "Afghanistan", PhoneCode = 93 },
// ...
new Country() { Name = "Zimbabwe", PhoneCode = 263 }
});
}
Imports DevExpress.XtraEditors
listBoxControl1.DataSource = Country.Countries
listBoxControl1.DisplayMember = "Name"
listBoxControl1.ValueMember = "PhoneCode"
AddHandler listBoxControl1.SelectedValueChanged, AddressOf ListBoxControl1_SelectedValueChanged
Private Sub ListBoxControl1_SelectedValueChanged(ByVal sender As Object, ByVal e As EventArgs)
Dim listBoxControl = TryCast(sender, ListBoxControl)
Call XtraMessageBox.Show(listBoxControl.SelectedValue.ToString())
End Sub
Public Class Country
Public Property Name As String
Public Property PhoneCode As Integer
Public Overrides Function ToString() As String
Return $"{Name}, {PhoneCode}"
End Function
Public Shared Countries As Country() = (
New Country() {
New Country() With {
.Name = "United States",
.PhoneCode = 1
},
New Country() With {
.Name = "Afghanistan",
.PhoneCode = 93
},
New Country() With {
.Name = "Zimbabwe",
.PhoneCode = 263
}
}
)
End Class
The following code snippets (auto-collected from DevExpress Examples) contain references to the DataSource 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.
if (!DesignMode)
listBoxControl1.DataSource = DiagramRepository.GetDiagramNames();
}
}
Control.DataSource = dataSource;
Control.DisplayMember = classInfo.DefaultProperty;
reporting-crosstab-customization/CS/CrosstabControlCustomizationExample/Form1.cs#L19
InitializeComponent();
listBoxControl1.DataSource = ReportDescriptionData.GetData();
}
dashboard-constant-lines/CS/ConstantLineExtension.Win/ConstantLineDialog.cs#L39
void SetupListBoxControl() {
listBoxControl1.DataSource = customConstantLines;
listBoxControl1.DisplayMember = "Name";
map-for-winforms-azure-routing/CS/Form1.cs#L46
routeInfoLayer.Error += RouteInfoLayer_Error;
waypointsListBoxControl.DataSource = geoPoints;
mapControl.Zoom(6);
Private Sub PopulateListBox()
If Not DesignMode Then listBoxControl1.DataSource = DiagramRepository.GetDiagramNames()
End Sub
End If
Control.DataSource = dataSource
Control.DisplayMember = classInfo.DefaultProperty
reporting-crosstab-customization/VB/CrossTabControlCustomizationExample/Form1.vb#L20
InitializeComponent()
listBoxControl1.DataSource = ReportDescriptionData.GetData()
End Sub
map-for-winforms-azure-routing/VB/Form1.vb#L40
AddHandler routeInfoLayer.Error, AddressOf RouteInfoLayer_Error
waypointsListBoxControl.DataSource = geoPoints
mapControl.Zoom(6)
See Also