Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

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
)
public void Remove (
	DataColumn column
)
public function Remove (
	column : DataColumn
)
Not applicable.

Parameters

column

The DataColumn to remove.

Exception typeCondition

ArgumentNullException

The column parameter is a null reference (Nothing in Visual Basic).

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);
    }
}

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2015 Microsoft