DataGrid.DataMember プロパティとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

DataGrid.DataMember プロパティ

System.Windows.Forms.DataGrid コントロールでグリッドを表示するための、DataSource 内の特定のリストを取得または設定します。

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

Public Property DataMember As
 String

Visual Basic (使用法)

Dim instance As DataGrid
Dim value As String

value = instance.DataMember

instance.DataMember = value

public string DataMember { get;
 set; }

C++

public:
property String^ DataMember {
    String^ get ();
    void set (String^ value);
}

/** @property */
public String get_DataMember ()

/** @property */
public void set_DataMember (String value)

JScript

public function get DataMember
 () : String

public function set DataMember
 (value : String)

プロパティ値
DataSource のリスト。既定値は空の文字列 ("") です。

解説

DataSource で複数のソースデータを格納している場合は、DataMember をソースのいずれかに設定します。たとえば、DataSource が DataSet または DataViewManager であり、Customers、Orders、および OrderDetails という名前の 3 つのテーブルを格納している場合は、バインド先のテーブルを 1 つ指定する必要があります。DataSet または DataViewManager が DataTable を 1 つだけ格納している場合は、DataMember をその DataTable の TableName に設定する必要があります。

DataSource が DataRelation オブジェクトを格納している DataSet に設定されている場合、各行ヘッダーに正符号 (+) が付いた親テーブルが表示されます。正符号をクリックすると、子テーブルへのリンクを保持するノードが表示されます。たとえば、DataSet が Customers と Orders という名前の 2 つの DataTable オブジェクトを格納している場合は、DataMember を Customers テーブルに設定すると、System.Windows.Forms.DataGrid で各行ヘッダーに正符号が付いた親テーブルが表示されます。ただし、DataMember が Orders に設定されている場合、行ヘッダーは空白になります。

DataSource が DataTable、DataView、コレクション、または配列の場合は、DataMember プロパティを設定すると、例外がスローされます。

メモ
実行時に DataSource プロパティをリセットするには、SetDataBinding メソッドを使用する必要があります。ただし、DataMember プロパティだけはいつでも有効なテーブル名にリセットできます。

使用例

System.Windows.Forms.DataGrid コントロールの DataSource プロパティおよび DataMember プロパティを設定するコード例を次に示します。

Visual Basic

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

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);
}

C++

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.get_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);
} //SetSourceAndMember