DataTableCollection.Remove Method (String, String)

 

Removes the DataTable object with the specified name from the collection.

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

public void Remove(
	string name,
	string tableNamespace
)

Parameters

name
Type: System.String

The name of the DataTable object to remove.

tableNamespace
Type: System.String

The name of the DataTable namespace to look in.

Exception Condition
ArgumentException

The collection does not have a table with the specified name.

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 Contains and CanRemove methods to test whether a named table exists and can be removed. If so, the Remove method is called to remove the table.

private void RemoveTables()
{
    // Set the name of the table to test for and remove.
    string name = "Suppliers";

    // Presuming a DataGrid is displaying more than one table, get its DataSet.
    DataSet thisDataSet = (DataSet)DataGrid1.DataSource;
    DataTableCollection tablesCol = thisDataSet.Tables;
    if (tablesCol.Contains(name) && tablesCol.CanRemove(tablesCol[name])) 
        tablesCol.Remove(name);
}

.NET Framework
Available since 2.0
Return to top
Show: