DataColumnCollection.CanRemove(DataColumn) Método

Definição

Namespace:

System.Data

Assembly:

System.Data.Common.dll

Origem:

DataColumnCollection.cs

Verifica se uma coluna específica pode ser removida da coleção.

public:
 bool CanRemove(System::Data::DataColumn ^ column);

public bool CanRemove (System.Data.DataColumn? column);

member this.CanRemove : System.Data.DataColumn -> bool

Public Function CanRemove (column As DataColumn) As Boolean

Parâmetros

column

DataColumn

Um DataColumn na coleção.

Retornos

Boolean

true se a coluna puder ser removida. false se,

• O parâmetro column é null.

• A coluna não pertence a esta coleção.

• A coluna é parte de uma relação.

• Expressão de outra coluna depende desta coluna.

Exceções

ArgumentNullException

O parâmetro column é nulo.

ArgumentException

A coluna não pertence a esta coleção.

- ou -

A coluna é parte de uma relação.

- ou -

Expressão de outra coluna depende desta coluna.

Exemplos

O exemplo a seguir primeiro usa o Contains método para determinar se uma coluna específica é encontrada na coleção. Se encontrado, o CanRemove método testa se a coluna pode ser removida. Nesse caso, a coluna é removida com o Remove método .

private void RemoveColumn(string columnName, DataTable table)
{
    DataColumnCollection columns = table.Columns;
    if (columns.Contains(columnName))
        if (columns.CanRemove(columns[columnName]))
            columns.Remove(columnName);
}

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 
           columns.Remove(columnName)
        End If
    End If
End Sub

Comentários

O CanRemove método executa várias verificações antes de retornar um true resultado ou false . Isso inclui o seguinte: se a coluna existe, pertence à tabela ou está envolvida em uma restrição ou relação.

Use o CanRemove método antes de tentar remover qualquer coluna de uma coleção. Você também pode usar o Contains método para determinar se uma coluna específica existe antes de tentar removê-la.

Confira também

• Contains(String)
• Remove(DataColumn)