DataGridView.DataMember Property

 
System_CAPS_noteNote

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

Gets or sets the name of the list or table in the data source for which the DataGridView is displaying data.

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

Public Property DataMember As String

Property Value

Type: System.String

The name of the table or list in the DataSource for which the DataGridView is displaying data. The default is Empty.

Exception Condition
Exception

An error occurred in the data source and either there is no handler for the DataError event or the handler has set the DataGridViewDataErrorEventArgs.ThrowException property to true. The exception object can typically be cast to type FormatException.

This property is useful when binding to a data source that contains multiple lists or tables. You do not need to set this property when binding to a data source that contains a single list or table. For example, you can bind a DataGridView control to a DataSet that contains a single table without setting this property. If the DataSet contains multiple tables, however, you must set this property to the name of one of the tables.

The following code example illustrates a common use for this property. In the example, a DataGridView control named customersDataGridView is bound to a DataSet named customersDataSet. This DataSet contains a table named "Customers". The DataMember property is set to the name of the table.

Private Sub BindData()

    With customersDataGridView
        .AutoGenerateColumns = True
        .DataSource = customersDataSet
        .DataMember = "Customers"
    End With

End Sub

.NET Framework
Available since 2.0
Return to top
Show: