DataColumn.ColumnName プロパティ

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

DataColumn.ColumnName プロパティ

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

名前空間: System.Data
アセンブリ: System.Data (system.data.dll 内)
構文

Visual Basic (宣言)

Public Property ColumnName As
 String

Visual Basic (使用法)

Dim instance As DataColumn
Dim value As String

value = instance.ColumnName

instance.ColumnName = value

C#

public string ColumnName { get;
 set; }

C++

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

J#

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

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

JScript

public function get ColumnName
 () : String

public function set ColumnName
 (value : String)

プロパティ値
列の名前。

例外

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

解説

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

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

使用例

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

Visual Basic

Private Sub PrintColumnNames(dataSet As
 DataSet)
    Dim table As DataTable
    Dim column As DataColumn 

    ' For each DataTable, print the ColumnName.
    For Each table in dataSet.Tables
        For Each column in
 table.Columns
        Console.WriteLine(column.ColumnName)
        Next
    Next
End Sub

Private Sub AddColumn(table As
 DataTable)
    Dim column As DataColumn
    column = New DataColumn()

    With column
        .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.
    table.Columns.Add(column)
End Sub

C#

private void PrintColumnNames(DataSet dataSet)
{
    // For each DataTable, print the ColumnName.
    foreach(DataTable table in dataSet.Tables)
    {
        foreach(DataColumn column in table.Columns)
        {
            Console.WriteLine(column.ColumnName);
        }
    }
}
 
private void AddColumn(DataTable table)
{
    DataColumn column;
    column = new DataColumn();
    column.ColumnName = "SupplierID";
    column.DataType = System.Type.GetType("System.String");
    column.Unique = true;
    column.AutoIncrement = false;
    column.Caption = "SupplierID";
    column.ReadOnly = false;

    // Add the column to the table's columns collection.
    table.Columns.Add(column);
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
DataColumn クラス
DataColumn メンバ
System.Data 名前空間
DataColumn.Caption プロパティ