DataGridView.DataMember Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets or sets the name of the list or table in the data source for which the DataGridView is displaying data.
public:
property System::String ^ DataMember { System::String ^ get(); void set(System::String ^ value); };
public string DataMember { get; set; }
member this.DataMember : string with get, set
Public Property DataMember As String
Property Value
The name of the table or list in the DataSource for which the DataGridView is displaying data. The default is Empty.
Exceptions
An error occurred in the data source and either there is no handler for the DataError event or the handler has set the ThrowException property to true
. The exception object can typically be cast to type FormatException.
Examples
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 void BindData()
{
customersDataGridView.AutoGenerateColumns = true;
customersDataGridView.DataSource = customersDataSet;
customersDataGridView.DataMember = "Customers";
}
Private Sub BindData()
With customersDataGridView
.AutoGenerateColumns = True
.DataSource = customersDataSet
.DataMember = "Customers"
End With
End Sub
Remarks
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.