This documentation is archived and is not being maintained.

DataColumnCollection.Remove Method (String)

Removes the DataColumn object that has the specified name from the collection.

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

public void Remove(
	string name
)

Parameters

name
Type: System.String
The name of the column to remove.

ExceptionCondition
ArgumentException

The collection does not have a column with the specified name.

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

The following example first uses the Contains method to determine whether a particular column is found in the collection. If it is found, the CanRemove method tests whether the column can be removed. If so, the column is removed with the Remove method.


private void RemoveColumnByName(string columnName)
{
    // Get the DataColumnCollection from a DataTable in a DataSet.
    DataColumnCollection columns = 
        ds.Tables["Suppliers"].Columns;

    if(columns.Contains(columnName))
        if(columns.CanRemove(columns[columnName])) 
            columns.Remove(columnName);
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: