IOrderedDictionary.Insert Method (Int32, Object, Object)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Inserts a key/value pair into the collection at the specified index.

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

abstract Insert : 
        index:int *
        key:Object *
        value:Object -> unit


Type: System.Int32

The zero-based index at which the key/value pair should be inserted.

Type: System.Object

The object to use as the key of the element to add.

Type: System.Object

The object to use as the value of the element to add. The value can be null.

Exception Condition

index is less than 0.


index is greater than Count.


key is null.


An element with the same key already exists in the IOrderedDictionary collection.


The IOrderedDictionary collection is read-only.


The IOrderedDictionary collection has a fixed size.

IOrderedDictionary accepts null as a valid value and allows duplicate elements.

If the index parameter is equal to Count, the value parameter is added to the end of the IOrderedDictionary collection.

In collections of contiguous elements, such as lists, the elements that follow the insertion point move down to accommodate the new element. If the collection is indexed, the indexes of the elements that are moved are also updated. This behavior does not apply to collections where elements are conceptually grouped together, such as a hash table.

The following code example demonstrates the implementation of a simple IOrderedDictionary based on the ArrayList class. The implemented IOrderedDictionary stores first names as the keys and last names as the values, with the added requirement that each first name is unique. This code is part of a larger code example provided for the IOrderedDictionary class.

No code example is currently available or this language may not be supported.

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