This documentation is archived and is not being maintained.

DataColumnCollection.Add Method (String)

Creates and adds a DataColumn object that has the specified name to the DataColumnCollection.

Namespace: System.Data
Assembly: System.Data (in system.data.dll)

public DataColumn Add (
	string columnName
)
public DataColumn Add (
	String columnName
)
public function Add (
	columnName : String
) : DataColumn
Not applicable.

Parameters

columnName

The name of the column.

Return Value

The newly created DataColumn.

Exception typeCondition

DuplicateNameException

The collection already has a column with the specified name. (The comparison is not case-sensitive.)

By default, the DataType for the new column is string.

If a null reference (Nothing in Visual Basic) or an empty string ("") is passed in for the name, a default name ("Column1", "Column2", and so on) is given to the column.

Use the Contains method to determine whether a column with the proposed name already exists in the collection.

If the collection is successfully changed by adding or removing columns, the CollectionChanged event occurs.

The following example creates and adds a new DataColumn to a DataColumnCollection of a DataTable.

Private Sub AddColumn()
    ' Get the DataColumnCollection from a table in a DataSet.
    Dim columns As DataColumnCollection = _
        DataSet1.Tables("Prices").Columns
    Dim column As DataColumn = columns.Add("Total")

    With column
       .DataType = System.Type.GetType("System.Decimal")
       .ReadOnly = True
       .Expression = "UnitPrice * Quantity"
       .Unique = False
    End With
End Sub

Windows 98, Windows Server 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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0
Show: