DataColumn.ColumnName 属性

  • 项目

获取或设置 DataColumnCollection 中的列的名称。

**命名空间:**System.Data
**程序集:**System.Data（在 system.data.dll 中）

语法

声明
Public Property ColumnName As String
用法
Dim instance As DataColumn
Dim value As String

value = instance.ColumnName

instance.ColumnName = value

public string ColumnName { get; set; }

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

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

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

public function get ColumnName () : String

public function set ColumnName (value : String)

属性值

列的名称。

异常

异常类型 条件

ArgumentException

属性设置为 空引用（在 Visual Basic 中为 Nothing） 或空字符串，且列属于一个集合。

DuplicateNameException

集合中已经存在同名称的列。名称比较不区分大小写。

备注

在创建 DataColumn 时，它没有 ColumnName 值。不过，在将 DataColumn 添加到 DataTable 对象的 DataColumnCollection 中时，会给予它一个默认的名称（“Column1”、“Column2”等）。

默认情况下，Caption 值设置为 ColumnName 值。

示例

下面的示例获取 DataSet 中的每个表中的每个列的 ColumnName。该示例还说明如何用新的 ColumnName 创建 DataColumn。

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

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 属性