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.

ExceptionCondition
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

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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft