DataColumnCollection.CanRemove メソッド

.NET Framework クラス ライブラリ リファレンス

DataColumnCollection.CanRemove メソッド

特定の列をコレクションから削除できるかどうかを確認します。

名前空間: System.Data
アセンブリ: System.Data (system.data.dll 内)
構文

Visual Basic (宣言)

Public Function CanRemove ( _
    column As DataColumn _
) As Boolean

Visual Basic (使用法)

Dim instance As DataColumnCollection
Dim column As DataColumn
Dim returnValue As Boolean

returnValue = instance.CanRemove(column)

C#

public bool CanRemove (
    DataColumn column
)

C++

public:
bool CanRemove (
    DataColumn^ column
)

J#

public boolean CanRemove (
    DataColumn column
)

JScript

public function CanRemove (
    column : DataColumn
) : boolean

パラメータ

column

コレクション内の DataColumn。

戻り値
列を削除できる場合は true。それ以外の場合は false。

例外

例外の種類	条件
ArgumentNullException	column パラメータが null 参照 (Visual Basic では Nothing) です。
ArgumentException	この列はこのコレクションに属していません。 または この列はリレーションシップの一部です。 または 他の列の式がこの列に依存します。

解説

CanRemove メソッドでは複数のチェックを実行した後、true または false の結果を返します。このとき、列が存在するかどうか、列がテーブルに属しているかどうか、列に制約またはリレーションシップがあるかどうかなどがチェックされます。

コレクションから列を削除する前に、CanRemove メソッドを使用します。列を削除しようとする前に、Contains メソッドを使用して、この列が存在するかどうかを確認できます。

使用例

最初に Contains メソッドを使用して、特定の列がコレクション内にあるかどうかを判断する例を次に示します。コレクション内にこの列が存在する場合は、CanRemove メソッドで、この列を削除できるかどうかが確認されます。削除できる場合は、Remove メソッドで列が削除されます。

Visual Basic

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

C#

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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
DataColumnCollection クラス
DataColumnCollection メンバ
System.Data 名前空間
Contains
Remove