Export (0) Print
Expand All

DataColumnCollection.Contains Method

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
)
public boolean Contains (
	String name
)
public function Contains (
	name : String
) : boolean
Not applicable.

Parameters

name

The ColumnName of the column to look for.

Return Value

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 void RemoveColumn(string columnName, DataTable table)
{
    DataColumnCollection columns = table.Columns;
 
    if (columns.Contains(columnName))
        if (columns.CanRemove(columns[columnName]))
            columns.Remove(columnName);
}

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0

Community Additions

ADD
Show:
© 2014 Microsoft