Contains Method

DataColumnCollection.Contains Method (String)


Checks whether the collection contains a column with the specified name.

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

Public Function Contains (
	name As String
) As Boolean


Type: System.String

The ColumnName of the column to look for.

Return Value

Type: System.Boolean

true if a column exists with this name; otherwise, false.

Use the Contains method to confirm the existence of a column before you perform additional operations on the column. The method returns false when two or more columns have the same name but different namespaces. The call does not succeed if there is any ambiguity when matching a column name to exactly one column.

The following example uses the Contains method and the CanRemove method to determine whether the column can be removed. If so, the column is removed.

Private Sub RemoveColumn(columnName As String, table As DataTable)
    Dim columns As DataColumnCollection = table.Columns

    If columns.Contains(columnName) Then 
        If columns.CanRemove(columns(columnName)) Then 
        End If
    End If
End Sub

.NET Framework
Available since 1.1
Return to top
© 2016 Microsoft