DataTableCollection.Remove Method (DataTable)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Removes the specified DataTable object from the collection.

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

public void Remove(
	DataTable table
)

Parameters

table
Type: System.Data.DataTable

The DataTable to remove.

Exception Condition
ArgumentNullException

The value specified for the table is null.

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

.NET Framework
Available since 1.1
Return to top
Show: