DataColumnCollection.Remove Method (DataColumn)

 

Removes the specified DataColumn object from the collection.

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

public void Remove(
	DataColumn column
)

Parameters

column
Type: System.Data.DataColumn

The DataColumn to remove.

Exception Condition
ArgumentNullException

The column parameter is null.

ArgumentException

The column does not belong to this collection.

-Or-

The column is part of a relationship.

-Or-

Another column's expression depends on this column.

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

The following example uses the Contains method to determine whether a named column exists. If so, the Item property returns the column. The CanRemove method then checks whether the column can be removed; if so, the Remove method removes it.

private void TestAndRemove(DataColumn colToRemove)
{
    DataColumnCollection columns; 
    // Get the DataColumnCollection from a DataTable in a DataSet.
    columns = DataSet1.Tables["Orders"].Columns;

    if(columns.Contains(colToRemove.ColumnName))
    {
        columns.Remove(colToRemove);
    }
}

.NET Framework
Available since 1.1
Return to top
Show: