OrderedDictionary.RemoveAt Method

Removes the entry at the specified index from the OrderedDictionary collection.

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

public void RemoveAt(
	int index
)

Parameters

index
Type: System.Int32

The zero-based index of the entry to remove.

Implements

IOrderedDictionary.RemoveAt(Int32)

ExceptionCondition
NotSupportedException

The OrderedDictionary collection is read-only.

ArgumentOutOfRangeException

index is less than zero.

- or -

index is equal to or greater than Count.

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.

The following code example demonstrates the modification of an OrderedDictionary collection. In this example, the RemoveAt method is used with the Count property to remove the last entry 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");
    }
}

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft