OrderedDictionary.Add Method (Object, Object)

 
System_CAPS_noteNote

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

Adds an entry with the specified key and value into the OrderedDictionary collection with the lowest available index.

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

Public Sub Add (
	key As Object,
	value As Object
)

Parameters

key
Type: System.Object

The key of the entry to add.

value
Type: System.Object

The value of the entry to add. This value can be null.

Exception Condition
NotSupportedException

The OrderedDictionary collection is read-only.

A key cannot be null, but a value can be.

You can also use the Item property to add new elements by setting the value of a key that does not exist in the OrderedDictionary collection; however, if the specified key already exists in the OrderedDictionary, setting the Item property overwrites the old value. In contrast, the Add method does not modify existing elements.

The following code example demonstrates the creation and population of an OrderedDictionary collection. This code is part of a larger code example that can be viewed at OrderedDictionary.

' Creates and initializes a OrderedDictionary.
Dim myOrderedDictionary As New OrderedDictionary()
myOrderedDictionary.Add("testKey1", "testValue1")
myOrderedDictionary.Add("testKey2", "testValue2")
myOrderedDictionary.Add("keyToDelete", "valueToDelete")
myOrderedDictionary.Add("testKey3", "testValue3")

Dim keyCollection As ICollection = myOrderedDictionary.Keys
Dim valueCollection As ICollection = myOrderedDictionary.Values

' Display the contents Imports the key and value collections
DisplayContents( _
    keyCollection, valueCollection, myOrderedDictionary.Count)

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