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.

Exception Condition
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
Available since 1.1
Return to top
Show: