This documentation is archived and is not being maintained.

SortedList(Of TKey, TValue).Add Method

Adds an element with the specified key and value into the SortedList(Of TKey, TValue).

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

'Declaration
Public Sub Add ( _
	key As TKey, _
	value As TValue _
)
'Usage
Dim instance As SortedList 
Dim key As TKey
Dim value As TValue

instance.Add(key, value)

Parameters

key
Type: TKey

The key of the element to add.

value
Type: TValue

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

Implements

IDictionary(Of TKey, TValue).Add(TKey, TValue)

ExceptionCondition
ArgumentNullException

key is Nothing.

ArgumentException

An element with the same key already exists in the SortedList(Of TKey, TValue).

A key cannot be Nothing, but a value can be, if the type of values in the sorted list, TValue, is a reference type.

You can also use the Item property to add new elements by setting the value of a key that does not exist in the SortedList(Of TKey, TValue); for example, myCollection["myNonexistentKey"] = myValue. However, if the specified key already exists in the SortedList(Of TKey, TValue), setting the Item property overwrites the old value. In contrast, the Add method does not modify existing elements.

If Count already equals Capacity, the capacity of the SortedList(Of TKey, TValue) is increased by automatically reallocating the internal array, and the existing elements are copied to the new array before the new element is added.

This method is an O(n) operation for unsorted data, where n is Count. It is an O(log n) operation if the new element is added at the end of the list. If insertion causes a resize, the operation is O(n).

The following code example creates an empty SortedList(Of 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 SortedList(Of TKey, TValue) class.

' Create a new sorted list of strings, with string  
' keys.  
Dim openWith As New SortedList(Of String, String)

' Add some elements to the list. 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 list. 
Try
    openWith.Add("txt", "winword.exe")
Catch 
    Console.WriteLine("An element with Key = ""txt"" already exists.")
End Try

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 3.0, 2.0, 1.0
Show: