CheckedListBox.DisplayMember Property


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Gets or sets a string that specifies a property of the objects contained in the list box whose contents you want to display.

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

public string DisplayMember { get; set; }

Property Value

Type: System.String

A string that specifies the name of a property of the objects contained in the list box. The default is an empty string ("").

By default the CheckedListBox displays the default string for the items it contains. However, the CheckedListBox can display diverse types of objects and you may want to change the displayed string by specifying the DisplayMember property. If the specified property does not exist, or the value of the DisplayMember property is an empty string (""), the results of the object's ToString method are displayed instead.

If the new value of the DisplayMember cannot be set, the previous value is maintained.

The following code example demonstrates initializing a CheckedListBox control by setting the CheckOnClick, SelectionMode, and ThreeDCheckBoxes properties. The example populates the CheckedListBox with controls and sets the DisplayMember to the Control.Name property of the control.

To run the example, paste the following code in a form containing a CheckedListBox named CheckedListBox1 and call the InitializeCheckListBox method from the form's constructor or Load method.

// This method initializes CheckedListBox1 with a list of all 
// the controls on the form. It sets the selection mode
// to single selection and allows selection with a single click.
// It adds itself to the list before adding itself to the form.

internal System.Windows.Forms.CheckedListBox CheckedListBox1;

private void InitializeCheckedListBox()
	this.CheckedListBox1 = new CheckedListBox();
	this.CheckedListBox1.Location = new System.Drawing.Point(40, 90);
	this.CheckedListBox1.CheckOnClick = true;
	this.CheckedListBox1.Name = "CheckedListBox1";
	this.CheckedListBox1.Size = new System.Drawing.Size(120, 94);
	this.CheckedListBox1.TabIndex = 1;
	this.CheckedListBox1.SelectionMode = SelectionMode.One;
	this.CheckedListBox1.ThreeDCheckBoxes = true;

	foreach ( Control aControl in this.Controls )
		this.CheckedListBox1.Items.Add(aControl, false);

	this.CheckedListBox1.DisplayMember = "Name";

.NET Framework
Available since 1.1
Return to top