OrderedDictionary.Remove メソッド

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

OrderedDictionary.Remove メソッド

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

指定したキーを持つエントリを OrderedDictionary コレクションから削除します。

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

Visual Basic (宣言)

Public Sub Remove ( _
    key As Object _
)

Visual Basic (使用法)

Dim instance As OrderedDictionary
Dim key As Object

instance.Remove(key)

C#

public void Remove (
    Object key
)

C++

public:
virtual void Remove (
    Object^ key
) sealed

J#

public final void Remove (
    Object key
)

JScript

public final function Remove (
    key : Object
)

パラメータ

key

削除するエントリのキー。

例外

例外の種類	条件
NotSupportedException	OrderedDictionary コレクションが読み取り専用です。

解説

空白になった位置を埋めるために、削除されたエントリの後にあるエントリの位置が繰り上がり、繰り上がったエントリのインデックスも更新されます。

指定した名前のエントリが OrderedDictionary コレクションに格納されていない場合、OrderedDictionary は変更されず、例外は返されません。

使用例

OrderedDictionary コレクションの変更方法を示すコード例を次に示します。この例では、Remove メソッドを使用して、キー "keyToDelete" を持つエントリを OrderedDictionary から削除します。このコードは、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 名前空間