DataColumn.ColumnName プロパティ

DataColumnCollection 内の列名を取得または設定します。

Public Property ColumnName As String
[C#]
public string ColumnName {get; set;}
[C++]
public: __property String* get_ColumnName();public: __property void set_ColumnName(String*);
[JScript]
public function get ColumnName() : String;public function set ColumnName(String);

プロパティ値

列の名前。

例外

例外の種類	条件
ArgumentException	このプロパティは null 参照 (Visual Basic では Nothing) または空の文字列に設定され、列がコレクションに属しています。
DuplicateNameException	同じ名前の列がコレクション内に既に存在します。名前の比較では、大文字と小文字が区別されません。

解説

作成された DataColumn には ColumnName 値がありません。ただし、 DataColumn を DataTable オブジェクトの DataColumnCollection に追加すると、列に既定の名前 ("Column1"、"Column2" など) が指定されます。

既定では、 Caption 値は ColumnName 値に設定されます。

使用例

[Visual Basic, C#, C++] DataSet 内のすべてのテーブルのすべての列の ColumnName を取得する例を次に示します。この例では、新しい ColumnName で DataColumn を作成する方法も示します。

 
Private Sub PrintColumnNames(myDataSet As DataSet)
 Dim myTable As DataTable
 Dim myColumn As DataColumn 
 ' For each table in the DataSet, print the ColumnName.
 For Each myTable in myDataSet.Tables
 For Each myColumn in myTable.Columns
 Console.WriteLine(myColumn.ColumnName)
 Next
 Next
 End Sub
 
 Private Sub AddColumn(myTable As DataTable)
 Dim myColumn As DataColumn
 myColumn = New DataColumn()
 With myColumn
 .ColumnName = "SupplierID"
 .DataType = System.Type.GetType("System.String")
 .Unique = True
 .AutoIncrement = False
 .Caption = "SupplierID"
 .ReadOnly = False
 End With
 ' Add the column to the table's columns collection.
 myTable.Columns.Add(myColumn)
 End Sub

[C#] 
private void PrintColumnNames(DataSet myDataSet){
    // For each table in the DataSet, print the ColumnName.
    foreach(DataTable myTable in myDataSet.Tables){
       foreach(DataColumn myColumn in myTable.Columns){
          Console.WriteLine(myColumn.ColumnName);
       }
    }
 }
 
 private void AddColumn(DataTable myTable){
    DataColumn myColumn;
    myColumn = new DataColumn();
    myColumn.ColumnName = "SupplierID";
    myColumn.DataType = System.Type.GetType("System.String");
    myColumn.Unique = true;
    myColumn.AutoIncrement = false;
    myColumn.Caption = "SupplierID";
    myColumn.ReadOnly = false;
    // Add the column to the table's columns collection.
    myTable.Columns.Add(myColumn);
 }

[C++] 
private:
void PrintColumnNames(DataSet* myDataSet){
    // For each table in the DataSet, print the ColumnName.
    System::Collections::IEnumerator* myEnum = myDataSet->Tables->GetEnumerator();
    while (myEnum->MoveNext())
    {
       DataTable* myTable = __try_cast<DataTable*>(myEnum->Current);
       System::Collections::IEnumerator* myEnum1 = myTable->Columns->GetEnumerator();
       while (myEnum1->MoveNext())
       {
          DataColumn* myColumn = __try_cast<DataColumn*>(myEnum1->Current);
          Console::WriteLine(myColumn->ColumnName);
       }
    }
 }
 
private:
 void AddColumn(DataTable* myTable){
    DataColumn* myColumn;
    myColumn = new DataColumn();
    myColumn->ColumnName = S"SupplierID";
    myColumn->DataType = System::Type::GetType(S"System.String");
    myColumn->Unique = true;
    myColumn->AutoIncrement = false;
    myColumn->Caption = S"SupplierID";
    myColumn->ReadOnly = false;
    // Add the column to the table's columns collection.
    myTable->Columns->Add(myColumn);
 }

[JScript] JScript のサンプルはありません。Visual Basic、C#、および C++ のサンプルを表示するには、このページの左上隅にある言語のフィルタ ボタン をクリックします。

必要条件

プラットフォーム: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 ファミリ, .NET Compact Framework - Windows CE .NET

参照

DataColumn クラス | DataColumn メンバ | System.Data 名前空間 | Caption