This documentation is archived and is not being maintained.

DataColumnCollection.CanRemove Method

Checks whether a specific column can be removed from the collection.

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

public bool CanRemove (
	DataColumn column
)
public boolean CanRemove (
	DataColumn column
)
public function CanRemove (
	column : DataColumn
) : boolean
Not applicable.

Parameters

column

A DataColumn in the collection.

Return Value

true if the column can be removed; otherwise, false.

Exception typeCondition

ArgumentNullException

The column parameter is a null reference (Nothing in Visual Basic).

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.

The CanRemove method performs several checks before returning a true or false result. This includes the following: whether the column exists, belongs to the table, or is involved in a constraint or relation.

Use the CanRemove method before you try to remove any column from a collection. You can also use the Contains method to determine whether a particular column exists before you try to remove it.

The following example first uses the Contains method to determine whether a particular column is found in the collection. If found, the CanRemove method tests whether the column can be removed. If so, the column is removed with the Remove method.

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
Show: