Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

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
)

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 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 .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.