OrderedDictionary.Remove Method (Object)

 

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

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

Public Sub Remove (
	key As Object
)

Parameters

key
Type: System.Object

The key of the entry to remove.

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

Universal Windows Platform
Available since 10
.NET Framework
Available since 2.0
Return to top
Show: