Export (0) Print
Expand All

DataColumnCollection.Add Method (String, Type)

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

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

public DataColumn Add(
	string columnName,
	Type type
)

Parameters

columnName
Type: System.String

The ColumnName to use when you create the column.

type
Type: System.Type

The DataType of the new column.

Return Value

Type: System.Data.DataColumn
The newly created DataColumn.

ExceptionCondition
DuplicateNameException

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

InvalidExpressionException

The expression is invalid. See the Expression property for more information about how to create expressions.

If null 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()
    Dim columns As DataColumnCollection = _
        DataSet1.Tables("Orders").Columns

    ' Add a new column and return it. 
    Dim column As DataColumn = columns.Add( _
        "Total", System.Type.GetType("System.Decimal"))
    column.ReadOnly = True
    column.Unique = False 
End Sub

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0
Show:
© 2015 Microsoft