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
)

Parameters

table
Type: System.Data.DataTable

The DataTable to remove.

ExceptionCondition
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

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft