BaseListBoxControl.DataSource Property

Gets or sets the data source that provides items to display in the control.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v19.2.dll

Declaration

C#

[DefaultValue(null)]
[DXCategory("Data")]
public virtual object DataSource { get; set; }

VB.NET

<DefaultValue(Nothing)>
<DXCategory("Data")>
Public Overridable Property DataSource As Object

Property Value

Type	Default	Description
Object	*null*	A data source object whose data is displayed by the ListBox control.

Remarks

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:

• BaseListBoxControl.ValueMember - Gets or sets the field name in the bound data source whose contents are assigned to item values.
• BaseListBoxControl.DisplayMember - Gets or sets the name of the data source field that provides display text for listbox items. This property is not supported when listbox items are rendered based on Item Templates
• CheckedListBoxControl: BaseCheckedListBoxControl.CheckMember - Gets or sets the name of the data source field that provides check states for listbox items.
• ImageListBoxControl: BaseImageListBoxControl.ImageMember - Gets or sets the name of the data source field that provides images for listbox items. This property is not supported when listbox items are rendered based on Item Templates.
• ImageListBoxControl: BaseImageListBoxControl.ImageIndexMember - Gets or sets the name of the data source field that provides image indexes for listbox items. This property is not supported when listbox items are rendered based on Item Templates.

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

Related GitHub Examples

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.

VB.NET

how-to-implement-the-insert-document-field-dialog-winforms-version-t223036/VB/WindowsFormsApplication1/InsertFieldModules/ucCREATEDATE.vb#L29

listBoxControlFormats.DataSource = listSource
listBoxControlFormats.DisplayMember = "DisplayName"

how-to-create-a-popupcontaineredit-control-with-a-checkedlistboxcontrol-in-the-popuform-e4688/VB/NewProject/PopupContainerEditHelper.vb#L90

Get
    Return CheckedListBox.DataSource
End Get

how-to-drag-drop-listboxcontrol-items-between-listboxcontrols-bound-mode-e2475/VB/Form1.vb#L122

listBoxControl1.DataSource = t1
listBoxControl1.ValueMember = "ID"

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

Get
    Return imageListBox.DataSource
End Get

how-to-filter-grid-columns-using-separate-checkedlistboxcontrols-t124162/VB/Form1.vb#L50

Private Sub gridControl1_DataSourceChanged(ByVal sender As Object, ByVal e As EventArgs)
    nameColumnFilter.DataSource = gridView1.DataController.GetUniqueColumnValues("Name", gridView1.RowCount, True, False, Nothing).ToList()
    categoryColumnFilter.DataSource = gridView1.DataController.GetUniqueColumnValues("Category", gridView1.RowCount, True, False, Nothing).ToList()

C#

how-to-create-a-popupcontaineredit-control-with-a-checkedlistboxcontrol-in-the-popuform-e4688/CS/NewProject/PopupContainerEditHelper.cs#L93

{
    get { return CheckedListBox.DataSource; }
    set { CheckedListBox.DataSource = value; }

how-to-drag-drop-listboxcontrol-items-between-listboxcontrols-bound-mode-e2475/CS/Form1.cs#L127

listBoxControl1.DataSource = t1;
listBoxControl1.ValueMember = "ID";

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

get {
    return imageListBox.DataSource;
}

how-to-filter-grid-columns-using-separate-checkedlistboxcontrols-t124162/CS/Form1.cs#L58

{
    nameColumnFilter.DataSource = gridView1.DataController.GetUniqueColumnValues("Name", gridView1.RowCount, true, false, null).ToList<object>();
    categoryColumnFilter.DataSource = gridView1.DataController.GetUniqueColumnValues("Category", gridView1.RowCount, true, false, null).ToList<object>();

how-to-implement-the-insert-document-field-dialog-winforms-version-t223036/CS/WindowsFormsApplication1/InsertFieldModules/ucPAGENUMBER.cs#L41

listBoxControlAttributes.DataSource = listSource;
listBoxControlAttributes.DisplayMember = "DisplayName";