DataTableCollection.CanRemove(DataTable) Method

Reference

Definition

Namespace:: System.Data

Assembly:: System.Data.Common.dll

Assembly:: System.Data.dll

Assembly:: netstandard.dll

Source:: DataTableCollection.cs

Source:: DataTableCollection.cs

Source:: DataTableCollection.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Verifies whether the specified DataTable object can be removed from the collection.

public:
 bool CanRemove(System::Data::DataTable ^ table);

public bool CanRemove (System.Data.DataTable? table);

public bool CanRemove (System.Data.DataTable table);

member this.CanRemove : System.Data.DataTable -> bool

Public Function CanRemove (table As DataTable) As Boolean

Parameters

table: DataTable

The DataTable in the collection to perform the check against.

Returns

Boolean

true if the table can be removed; otherwise false.

Examples

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

private void RemoveTables()
{
    DataTable table;

    // presuming a DataGrid is displaying more than one table, get its DataSet.
    DataSet thisDataSet = (DataSet)DataGrid1.DataSource;
    while (thisDataSet.Tables.Count > 0)
    {
        table = thisDataSet.Tables[0];
        if (thisDataSet.Tables.CanRemove(table))
            thisDataSet.Tables.Remove(table);
    }
}

Private Sub RemoveTables()
    ' Presuming a DataGrid is displaying more than one table, 
    ' get its DataSet.
    Dim thisDataSet As DataSet = CType(DataGrid1.DataSource, DataSet)
    Do While thisDataSet.Tables.Count > 0
       Dim table As DataTable = thisDataSet.Tables(0)
       If thisDataSet.Tables.CanRemove(table) Then
          thisDataSet.Tables.Remove(table)
       End If
    Loop
End Sub

Applies to

Jaa