DataColumnCollection.Remove Método

Definição

Namespace:

System.Data

Assembly:

System.Data.Common.dll

Remove um objeto DataColumn da coleção.

Sobrecargas

Remove(DataColumn)	Remove o objeto DataColumn especificado da coleção.
Remove(String)	Remove da coleção o objeto DataColumn que tem o nome especificado.

Remove(DataColumn)

Origem:

DataColumnCollection.cs

Remove o objeto DataColumn especificado da coleção.

public:
 void Remove(System::Data::DataColumn ^ column);

public void Remove (System.Data.DataColumn column);

member this.Remove : System.Data.DataColumn -> unit

Public Sub Remove (column As DataColumn)

Parâmetros

column

DataColumn

O DataColumn a ser removido.

Exceções

ArgumentNullException

O parâmetro column é null.

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 usa o Contains método para determinar se existe uma coluna nomeada. Nesse caso, a Item[] propriedade retorna a coluna. Em CanRemove seguida, o método verifica se a coluna pode ser removida; nesse caso, o método a Remove remove.

private void TestAndRemove(DataColumn colToRemove)
{
    DataColumnCollection columns;
    // Get the DataColumnCollection from a DataTable in a DataSet.
    columns = DataSet1.Tables["Orders"].Columns;

    if(columns.Contains(colToRemove.ColumnName))
    {
        columns.Remove(colToRemove);
    }
}

Private Sub TestAndRemove(ByVal colToRemove As DataColumn)
    ' Get the DataColumnCollection from a DataTable in a DataSet.
    Dim columns As DataColumnCollection = _
        DataSet1.Tables("Orders").Columns
 
    If columns.Contains(colToRemove.ColumnName) Then
       columns.Remove(colToRemove)
    End If
End Sub

Comentários

Se a coleção for alterada com êxito adicionando ou removendo colunas, o evento de CollectionChanged ocorrerá.

Confira também

• Contains(String)
• CanRemove(DataColumn)
• Item[Int32]

Remove(String)

Origem:

DataColumnCollection.cs

Remove da coleção o objeto DataColumn que tem o nome especificado.

public:
 void Remove(System::String ^ name);

public void Remove (string name);

member this.Remove : string -> unit

Public Sub Remove (name As String)

Parâmetros

name

String

O nome da coluna a ser removida.

Exceções

ArgumentException

A coleção não tem uma coluna com o nome especificado.

Exemplos

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

private void RemoveColumnByName(string columnName)
{
    // Get the DataColumnCollection from a DataTable in a DataSet.
    DataColumnCollection columns =
        ds.Tables["Suppliers"].Columns;

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

Private Sub RemoveColumnByName(columnName As String)

    ' Get the DataColumnCollection from a DataTable in a DataSet.
    Dim columns As DataColumnCollection = _
        DataSet1.Tables("Orders").Columns

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

Comentários

Se a coleção for alterada com êxito adicionando ou removendo colunas, o evento de CollectionChanged ocorrerá.

Confira também

• Contains(String)