DataGrid.DataMember Property

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

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 specific list in a DataSource for which the DataGrid control displays a grid.

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

String

A list in a DataSource. The default is an empty string ("").

Examples

The following code example sets the DataSource and DataMember properties of a System.Windows.Forms.DataGrid control.

protected:
   Object^ source;

private:
   void SetSourceAndMember()
   {
      DataSet^ myDataSet = gcnew DataSet( "myDataSet" );
      DataTable^ tableCustomers = gcnew DataTable( "Customers" );
      myDataSet->Tables->Add( tableCustomers );
      // Insert code to populate the DataSet.

      // Set DataSource and DataMember with SetDataBinding method.
      String^ member;
      
      // The name of a DataTable is Customers.
      member = "Customers";
      dataGrid1->SetDataBinding( myDataSet, member );
   }

protected object source;

private void SetSourceAndMember(){

   DataSet myDataSet = new DataSet("myDataSet");
   DataTable tableCustomers = new DataTable("Customers");
   myDataSet.Tables.Add(tableCustomers);
   // Insert code to populate the DataSet.

   // Set DataSource and DataMember with SetDataBinding method.
   string member;
   // The name of a DataTable is Customers.
   member = "Customers";
   dataGrid1.SetDataBinding(myDataSet, member);
}

Private Sub SetSourceAndMember()
    Dim myDataSet As DataSet = New DataSet("myDataSet")
    Dim customersTable As DataTable = new DataTable("Customers")
    ' Insert code to set source to populate DataSet.
    
    ' Set DataSource and DataMember with SetDataBinding method.
    Dim member As String
    ' The name of a DataTable is Customers.
    member = "Customers"
    DataGrid1.SetDataBinding(myDataSet, member)
 End Sub

Remarks

If a DataSource contains multiple sources of data, you should set the DataMember to one of the sources. For example, if the DataSource is a DataSet or DataViewManager that contains three tables named Customers, Orders, and OrderDetails, you must specify one of the tables to bind to. If the DataSet or DataViewManager contains only one DataTable, you should set the DataMember to the TableName of that DataTable.

If the DataSource is set to a DataSet that contains DataRelation objects, parent tables will appear with a plus sign (+) in each row header. Clicking the plus sign causes a node to appear that contains links to child tables. For example, if a DataSet contains two DataTable objects named Customers and Orders, setting the DataMember to the Customers table causes the System.Windows.Forms.DataGrid to display a parent table with a plus sign visible on each row header. If the DataMember is set to Orders, however, the row headers will be blank.

If the DataSource is a DataTable, DataView, collection, or array, setting the DataMember property throws an exception.

Note

At run time, you must use the SetDataBinding method to reset the DataSource property. However, the DataMember property alone can be reset at any time to a valid table name.

Applies to

Partager via