BaseListBoxControl.DisplayMember Property

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

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v19.2.dll

Declaration

C#

[DefaultValue("")]
[DXCategory("Data")]
public virtual string DisplayMember { get; set; }

VB.NET

<DefaultValue("")>
<DXCategory("Data")>
Public Overridable Property DisplayMember As String

Property Value

Type	Default	Description
String	String.Empty	A string value specifying a field name in a data source.

Remarks

This property is in effect when the ListBox control is bound to a data source with the BaseListBoxControl.DataSource property and listbox items are painted in regular paint mode (Item Templates are not used).

Use the DisplayMember property to specify the field whose values are displayed within the list box control. To get text displayed by a specific list box item, use the BaseListBoxControl.GetItemText method.

Changing the DisplayMember property value at runtime raises the BaseListBoxControl.DisplayMemberChanged event.

Example

The following sample code declares a ChangeDisplayMember method that accepts two parameters:

• listBoxControl - a ListBoxControl;
• memberName - the name of a column already contained within the BaseListBoxControl.DataSource whose contents are to be displayed by ListBoxControl.

Use this method to assign a single column from a table to the DisplayMember property of the ListBoxControl. If the table bound to the control doesn’t contain the specified column, method execution will not take effect.

C#

using DevExpress.XtraEditors;
// ...
private void ChangeDisplayMember(ListBoxControl listBoxControl, string memberName){
   DataTable source = listBoxControl.DataSource as DataTable;
   if (source.Columns.Contains(memberName))
      listBoxControl.DisplayMember = memberName;
}

VB.NET

Imports DevExpress.XtraEditors
' ...
Private Sub ChangeDisplayMember(ByVal listBoxControl As ListBoxControl, _
 ByVal memberName As String)
   Dim source As DataTable
   source = listBoxControl.DataSource
   If source.Columns.Contains(memberName) Then
      listBoxControl.DisplayMember = memberName
   End If
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DisplayMember 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-create-a-popupcontaineredit-control-with-a-checkedlistboxcontrol-in-the-popuform-e4688/CS/NewProject/PopupContainerEditHelper.cs#L83

{
    get { return CheckedListBox.DisplayMember; }
    set

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

listBoxControl1.ValueMember = "ID";
listBoxControl1.DisplayMember = "Data";

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

public string DisplayMember {
    get { return imageListBox.DisplayMember; }
    set {

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

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

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

    listBoxControl1.DataSource = SkinManager.Default.Skins;
    listBoxControl1.DisplayMember = "SkinName";
}

VB.NET

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

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

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

Get
    Return CheckedListBox.DisplayMember
End Get

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

listBoxControl1.ValueMember = "ID"
listBoxControl1.DisplayMember = "Data"

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

Get
    Return imageListBox.DisplayMember
End Get

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

    listBoxControl1.DataSource = SkinManager.Default.Skins
    listBoxControl1.DisplayMember = "SkinName"
End Sub