DataTableCollection.Remove Method (DataTable)

Removes the specified DataTable object from the collection.

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

public void Remove (
	DataTable table
)
public void Remove (
	DataTable table
)
public function Remove (
	table : DataTable
)
Not applicable.

Parameters

table

The DataTable to remove.

Exception typeCondition

ArgumentNullException

The value specified for the table is a null reference (Nothing in Visual Basic).

ArgumentException

The table does not belong to this collection.

-or-

The table is part of a relationship.

The CollectionChanged event occurs when a table is successfully removed.

To determine whether a given table exists and can be removed before invoking Remove, use the Contains and the CanRemove methods.

The following example uses the CanRemove method to test whether each table can be removed from a DataSet. If so, the Remove method is called to remove the table.

public static void DataTableCollectionCanRemove()
{
    // create a DataSet with two tables
    DataSet dataSet = new DataSet();

    // create Customer table
    DataTable customersTable = new DataTable("Customers");
    customersTable.Columns.Add("customerId", 
        typeof(int) ).AutoIncrement = true;
    customersTable.Columns.Add("name",       
        typeof(string));
    customersTable.PrimaryKey = new DataColumn[] 
        { customersTable.Columns["customerId"] };

    // create Orders table
    DataTable ordersTable = new DataTable("Orders");
    ordersTable.Columns.Add("orderId",    
        typeof(int) ).AutoIncrement = true;
    ordersTable.Columns.Add("customerId", 
        typeof(int) );
    ordersTable.Columns.Add("amount",     
        typeof(double));
    ordersTable.PrimaryKey = new DataColumn[] 
        { ordersTable.Columns["orderId"] };

    dataSet.Tables.AddRange(new DataTable[] 
        {customersTable, ordersTable });

    // remove all tables
    // check if table can be removed and then
    // remove it, cannot use a foreach when
    // removing items from a collection
    while(dataSet.Tables.Count > 0)
    {
        DataTable table = dataSet.Tables[0];
        if(dataSet.Tables.CanRemove(table))
        {
            dataSet.Tables.Remove(table);
        }
    }

    Console.WriteLine("dataSet has {0} tables",     
        dataSet.Tables.Count);
}

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
Show: