SortedDictionary<TKey,TValue>.Add(TKey, TValue) Method

Definition

Adds an element with the specified key and value into the SortedDictionary<TKey,TValue>.

C#
public void Add(TKey key, TValue value);

Parameters

key
TKey

The key of the element to add.

value
TValue

The value of the element to add. The value can be null for reference types.

Implements

Exceptions

key is null.

An element with the same key already exists in the SortedDictionary<TKey,TValue>.

Examples

The following code example creates an empty SortedDictionary<TKey,TValue> of strings with string keys and uses the Add method to add some elements. The example demonstrates that the Add method throws an ArgumentException when attempting to add a duplicate key.

This code example is part of a larger example provided for the SortedDictionary<TKey,TValue> class.

C#
// Create a new sorted dictionary of strings, with string
// keys.
SortedDictionary<string, string> openWith =
    new SortedDictionary<string, string>();

// Add some elements to the dictionary. There are no
// duplicate keys, but some of the values are duplicates.
openWith.Add("txt", "notepad.exe");
openWith.Add("bmp", "paint.exe");
openWith.Add("dib", "paint.exe");
openWith.Add("rtf", "wordpad.exe");

// The Add method throws an exception if the new key is
// already in the dictionary.
try
{
    openWith.Add("txt", "winword.exe");
}
catch (ArgumentException)
{
    Console.WriteLine("An element with Key = \"txt\" already exists.");
}

Remarks

You can also use the Item[] property to add new elements by setting the value of a key that does not exist in the SortedDictionary<TKey,TValue>; for example, myCollection["myNonexistentKey"] = myValue (in Visual Basic, myCollection("myNonexistantKey") = myValue). However, if the specified key already exists in the SortedDictionary<TKey,TValue>, setting the Item[] property overwrites the old value. In contrast, the Add method throws an exception if an element with the specified key already exists.

A key cannot be null, but a value can be, if the value type TValue is a reference type.

This method is an O(log n) operation, where n is Count.

Applies to

Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1
UWP 10.0

See also