This topic has not yet been rated - Rate this topic

DataColumnCollection.Contains Method

.NET Framework 4.5

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

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

public bool Contains(
	string name
)

Parameters

name: 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.

Remarks

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.

Examples

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 void RemoveColumn(string columnName, DataTable table)
{
    DataColumnCollection columns = table.Columns;

    if (columns.Contains(columnName))
        if (columns.CanRemove(columns[columnName]))
            columns.Remove(columnName);
}

Version Information

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

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.

Reference

DataColumnCollection Class

System.Data Namespace

CanRemove

IndexOf

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)