DataColumn.ColumnName Property

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

public string ColumnName { get; set; }

[System.Data.DataSysDescription("DataColumnColumnNameDescr")]
public string ColumnName { get; set; }

member this.ColumnName : string with get, set

[<System.Data.DataSysDescription("DataColumnColumnNameDescr")>]
member this.ColumnName : string with get, set

Public Property ColumnName As String

Property Value

The name of the column.

Attributes

DataSysDescriptionAttribute

Exceptions

Examples

The following examples gets the ColumnName for every column in every table in a DataSet. The example also shows how to create a DataColumn with a new ColumnName.

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

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

Remarks

When a DataColumn is created, it has no ColumnName value. However, when the DataColumn is added to a DataColumnCollection for a DataTable object, it is given a default name ("Column1", "Column2", and so on).

By default, the Caption value is set to the ColumnName value.

See also

• Caption
• Using DataSets in ADO.NET