DisplayMember Property

DataGridViewComboBoxColumn.DisplayMember Property

 

Gets or sets a string that specifies the property or column from which to retrieve strings for display in the combo boxes.

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

[<TypeConverterAttribute("System.Windows.Forms.Design.DataMemberFieldConverter, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>]
member DisplayMember : string with get, set

Property Value

Type: System.String

A String that specifies the name of a property or column in the data source specified in the DataSource property. The default is String.Empty.

Exception Condition
InvalidOperationException

The value of the CellTemplate property is null.

The data for the values stored in a column of DataGridViewComboBoxCell objects is obtained from the DataGridView.DataSource. If this data comes from a nondefault property or column, then the DisplayMember property must be set to the necessary property name or column name.

If the cell values are internal values not visible to the user, then use DisplayMember and ValueMember to map the internal cell values to user-viewable values.

When the DataSource property is set to a string array, the DisplayMember property does not need to be set because each string in the array will be used as a valid display string and as a valid underlying value.

Getting or setting this property gets or sets the DisplayMember property of the object returned by the CellTemplate property. Setting this property also sets the DisplayMember property of every cell in the column and refreshes the column display. To override the specified value for individual cells, set the cell values after you set the column value.

The following code example demonstrates how to use a DataGridViewComboBoxColumn to aid in data entry of the title column. DisplayMember is set to the property name responsible for containing the user-viewable text. In this example, the DisplayMember is set to the same value as ValueMember because no mapping is necessary. This example is part of a larger example available in the DataGridViewComboBoxColumn class overview topic.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft