Export (0) Print
Expand All

OrderedDictionary.Remove Method

Removes the entry with the specified key from the OrderedDictionary collection.

Namespace:  System.Collections.Specialized
Assembly:  System (in System.dll)

public void Remove(
	Object key
)

Parameters

key
Type: System.Object

The key of the entry to remove.

Implements

IDictionary.Remove(Object)

ExceptionCondition
NotSupportedException

The OrderedDictionary collection is read-only.

ArgumentNullException

key is null.

The entries that follow the removed entry move up to occupy the vacated spot and the indexes of the entries that move are also updated.

If the OrderedDictionary collection does not contain an entry with the specified key, the OrderedDictionary remains unchanged and no exception is thrown.

The following code example demonstrates the modification of an OrderedDictionary collection. In this example, the Remove method is used to remove the entry with the key "keyToDelete" from the OrderedDictionary. This code is part of a larger code example that can be viewed at OrderedDictionary.

// 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 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft