Export (0) Print
Expand All

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

Parameters

name

The name of the column to remove.

Exception typeCondition

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

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

Community Additions

ADD
Show:
© 2015 Microsoft