This documentation is archived and is not being maintained.

ListControl.DisplayMember Property

Gets or sets the property to display for this ListControl.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in

Public Property DisplayMember As String
Dim instance As ListControl
Dim value As String

value = instance.DisplayMember

instance.DisplayMember = value
/** @property */
public String get_DisplayMember ()

/** @property */
public void set_DisplayMember (String value)

public function get DisplayMember () : String

public function set DisplayMember (value : String)

Property Value

A String specifying the name of an object property that is contained in the collection specified by the DataSource property. The default is an empty string ("").

The controls that inherit from ListControl can display diverse types of objects. If the specified property does not exist on the object or the value of DisplayMember is an empty string (""), the results of the object's ToString method are displayed instead.

If the new display member cannot be set, the previous display member setting is maintained.

The following code example is a complete application that shows how you can use DataSource, DisplayMember, ValueMember, and SelectedValue members of the ListControl class as implemented by the ListBox class. The example loads an ArrayList and the list box. When the user selects an item in the list box, the selected value is used to return the data associated with the selected item.

Imports System
Imports System.Windows.Forms
Imports System.Drawing
Imports System.Collections

Public Class USState
   Private myShortName As String
   Private myLongName As String
   Public Sub New(strLongName As String, strShortName As String)
      Me.myShortName = strShortName
      Me.myLongName = strLongName
   End Sub 'New
   Public ReadOnly Property ShortName() As String
         Return myShortName
      End Get
   End Property
   Public ReadOnly Property LongName() As String
         Return myLongName
      End Get
   End Property
   Public Overrides Function ToString() As String
      Return Me.ShortName + " - " + Me.LongName
   End Function 'ToString
End Class 'USState

Public Class ListBoxSample3
   Inherits Form
   Private ListBox1 As New ListBox()
   Private textBox1 As New TextBox()
   <STAThread()>  _
   Shared Sub Main()
      Application.Run(New ListBoxSample3())
   End Sub 'Main
   Public Sub New()
      Me.ClientSize = New Size(292, 181)
      Me.Text = "ListBox Sample3"
      ListBox1.Location = New Point(24, 16)
      ListBox1.Name = "ListBox1"
      ListBox1.Size = New Size(232, 130)
      textBox1.Location = New Point(24, 160)
      textBox1.Name = "textBox1"
      textBox1.Size = New Size(240, 24)
      Me.Controls.AddRange(New Control() {ListBox1, textBox1})
      ' Populates the list box using DataSource. 
      ' DisplayMember is used to display just the long name of each state.
      Dim USStates As New ArrayList()
      USStates.Add(New USState("Alabama", "AL"))
      USStates.Add(New USState("Washington", "WA"))
      USStates.Add(New USState("West Virginia", "WV"))
      USStates.Add(New USState("Wisconsin", "WI"))
      USStates.Add(New USState("Wyoming", "WY"))
      AddHandler ListBox1.SelectedValueChanged, AddressOf ListBox1_SelectedValueChanged
      ListBox1.DataSource = USStates
      ListBox1.DisplayMember = "LongName"
      ListBox1.ValueMember = "ShortName"
   End Sub 'New
   Private Sub InitializeComponent()
   End Sub 'InitializeComponent
   Private Sub ListBox1_SelectedValueChanged(sender As Object, e As EventArgs)
      If ListBox1.SelectedIndex <> - 1 Then
         textBox1.Text = ListBox1.SelectedValue.ToString()
      End If
   End Sub 'ListBox1_SelectedValueChanged
End Class 'ListBoxSample3

package MyListControlSample;

import System.*;
import System.Windows.Forms.*;
import System.Drawing.*;
import System.Collections.*;

public class USState
    private String myShortName;
    private String myLongName;

    public USState(String strLongName, String strShortName)
        this.myShortName = strShortName;
        this.myLongName = strLongName;
    } //USState

    /** @property
    public String get_ShortName()
        return myShortName;

    /** @property 
    public String get_LongName()
        return myLongName;

    public String ToString()
        return this.get_ShortName() + " - " + this.get_LongName();
    } //ToString
} //USState

public class ListBoxSample3 extends Form
    private ListBox listBox1 = new ListBox();
    private TextBox textBox1 = new TextBox();

    /** @attribute STAThread()
    public static void main(String[] args)
        Application.Run(new ListBoxSample3());
    } //main

    public ListBoxSample3()
        this.set_ClientSize(new Size(292, 181));
        this.set_Text("ListBox Sample3");

        listBox1.set_Location(new Point(24, 16));
        listBox1.set_Size(new Size(232, 130));
        textBox1.set_Location(new Point(24, 160));
        textBox1.set_Size(new Size(240, 24));
        this.get_Controls().AddRange(new Control[] { listBox1, textBox1 });

        // Populates the list box using DataSource. 
        // DisplayMember is used to display just the long name of each state.
        ArrayList uSStates = new ArrayList();
        uSStates.Add(new USState("Alabama", "AL"));
        uSStates.Add(new USState("Washington", "WA"));
        uSStates.Add(new USState("West Virginia", "WV"));
        uSStates.Add(new USState("Wisconsin", "WI"));
        uSStates.Add(new USState("Wyoming", "WY"));

            new EventHandler(listBox1_SelectedValueChanged));
    } //ListBoxSample3
    private void InitializeComponent()
    } //InitializeComponent

    private void listBox1_SelectedValueChanged(Object sender, EventArgs e)
        if (listBox1.get_SelectedIndex() != -1) {
    } //listBox1_SelectedValueChanged
} //ListBoxSample3 

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0