OrderedDictionary.Contains メソッド

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

OrderedDictionary.Contains メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

OrderedDictionary コレクションに特定のキーが格納されているかどうかを判断します。

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

Visual Basic (宣言)

Public Function Contains ( _
    key As Object _
) As Boolean

Visual Basic (使用法)

Dim instance As OrderedDictionary
Dim key As Object
Dim returnValue As Boolean

returnValue = instance.Contains(key)

C#

public bool Contains (
    Object key
)

C++

public:
virtual bool Contains (
    Object^ key
) sealed

J#

public final boolean Contains (
    Object key
)

JScript

public final function Contains (
    key : Object
) : boolean

パラメータ

key

OrderedDictionary コレクション内で検索されるキー。

戻り値
指定したキーを持つ要素が OrderedDictionary コレクションに格納されている場合は true。それ以外の場合は false。

解説

Item プロパティを使用すると、キーが存在しない場合、またはキーが null 参照 (Visual Basic では Nothing) の場合に null 値を返すことができます。Contains メソッドを使用すると、特定のキーが OrderedDictionary コレクション内に存在するかどうかを確認できます。

使用例

OrderedDictionary コレクションの変更方法を示すコード例を次に示します。この例では、Contains メソッドを使用して、エントリを削除する前に、そのエントリが存在するかどうかを確認します。このコードは、OrderedDictionary で参照できるコード例の一部です。

Visual Basic

' Modifying the OrderedDictionary
If Not myOrderedDictionary.IsReadOnly Then

    ' Insert a new key to the beginning of the OrderedDictionary
    myOrderedDictionary.Insert(0, "insertedKey1",
 "insertedValue1")

    ' Modify the value of the entry with the key "testKey2"
    myOrderedDictionary("testKey2") = "modifiedValue"

    ' Remove the last entry from the OrderedDictionary: "testKey3"
    myOrderedDictionary.RemoveAt(myOrderedDictionary.Count - 1)

    ' Remove the "keyToDelete" entry, if it exists
    If (myOrderedDictionary.Contains("keyToDelete"))
 Then
        myOrderedDictionary.Remove("keyToDelete")
    End If
End If

C#

// Modifying the OrderedDictionary
if (!myOrderedDictionary.IsReadOnly)
{
    // Insert a new key to the beginning of the OrderedDictionary
    myOrderedDictionary.Insert(0, "insertedKey1", "insertedValue1");

    // Modify the value of the entry with the key "testKey2"
    myOrderedDictionary["testKey2"] = "modifiedValue";

    // Remove the last entry from the OrderedDictionary: "testKey3"
    myOrderedDictionary.RemoveAt(myOrderedDictionary.Count - 1);

    // Remove the "keyToDelete" entry, if it exists
    if (myOrderedDictionary.Contains("keyToDelete"))
    {
        myOrderedDictionary.Remove("keyToDelete");
    }
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, 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

参照

関連項目
OrderedDictionary クラス
OrderedDictionary メンバ
System.Collections.Specialized 名前空間