DataColumnCollection.Remove Method (DataColumn)

 
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 DataColumn object from the collection.

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

Public Sub Remove (
	column As DataColumn
)

Parameters

column
Type: System.Data.DataColumn

The DataColumn to remove.

Exception Condition
ArgumentNullException

The column parameter is null.

ArgumentException

The column does not belong to this collection.

-Or-

The column is part of a relationship.

-Or-

Another column's expression depends on this column.

If the collection is successfully changed by adding or removing columns, the CollectionChanged event occurs.

The following example uses the Contains method to determine whether a named column exists. If so, the Item property returns the column. The CanRemove method then checks whether the column can be removed; if so, the Remove method removes it.

Private Sub TestAndRemove(ByVal colToRemove As DataColumn)
    ' Get the DataColumnCollection from a DataTable in a DataSet.
    Dim columns As DataColumnCollection = _
        DataSet1.Tables("Orders").Columns

    If columns.Contains(colToRemove.ColumnName) Then
       columns.Remove(colToRemove)
    End If
End Sub

.NET Framework
Available since 1.1
Return to top
Show: