DataColumnCollection.Remove メソッド

定義

名前空間:

System.Data

アセンブリ:

System.Data.Common.dll

DataColumn オブジェクトをコレクションから削除します。

オーバーロード

Remove(DataColumn)	指定した DataColumn オブジェクトをコレクションから削除します。
Remove(String)	指定した名前の DataColumn オブジェクトをコレクションから削除します。

Remove(DataColumn)

ソース:

DataColumnCollection.cs

指定した DataColumn オブジェクトをコレクションから削除します。

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)

パラメーター

column

DataColumn

削除する DataColumn。

例外

ArgumentNullException

column パラメーターが null です。

ArgumentException

この列はこのコレクションに属していません。

-または-

この列はリレーションシップの一部です。

-または-

他の列の式がこの列に依存します。

例

次の例では、 メソッドを Contains 使用して、名前付き列が存在するかどうかを判断します。 その場合、プロパティは Item[] 列を返します。 次に、 メソッドは CanRemove 列を削除できるかどうかを確認します。削除できる場合は、その列を 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

注釈

列の追加または削除によってコレクションが正常に変更されると、イベントが CollectionChanged 発生します。

こちらもご覧ください

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

Remove(String)

ソース:

DataColumnCollection.cs

指定した名前の DataColumn オブジェクトをコレクションから削除します。

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

public void Remove (string name);

member this.Remove : string -> unit

Public Sub Remove (name As String)

パラメーター

name

String

削除する列の名前。

例外

ArgumentException

このコレクションには指定した名前の列がありません。

例

次の例では、最初に メソッドを Contains 使用して、コレクション内の特定の列が見つかるかどうかを判断します。 見つかった場合、メソッドは CanRemove 列を削除できるかどうかをテストします。 その場合、 メソッドを使用 Remove して列が削除されます。

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

注釈

列の追加または削除によってコレクションが正常に変更されると、イベントが CollectionChanged 発生します。

こちらもご覧ください

• Contains(String)