Export (0) Print
Expand All

Dictionary(Of TKey, TValue).Item Property

Gets or sets the value associated with the specified key.

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

'Declaration
Public Property Item ( _
	key As TKey _
) As TValue

Parameters

key
Type: TKey
The key of the value to get or set.

Property Value

Type: TValue
The value associated with the specified key. If the specified key is not found, a get operation throws a KeyNotFoundException, and a set operation creates a new element with the specified key.

Implements

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

ExceptionCondition
ArgumentNullException

key is Nothing.

KeyNotFoundException

The property is retrieved and key does not exist in the collection.

This property provides the ability to access a specific element in the collection by using the following C# syntax: myCollection[key] (myCollection(key) in Visual Basic).

You can also use the Item property to add new elements by setting the value of a key that does not exist in the Dictionary(Of TKey, TValue). When you set the property value, if the key is in the Dictionary(Of TKey, TValue), the value associated with that key is replaced by the assigned value. If the key is not in the Dictionary(Of TKey, TValue), the key and value are added to the dictionary. In contrast, the Add method does not modify existing elements.

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

The C# language uses the this keyword to define the indexers instead of implementing the Item property. Visual Basic implements Item as a default property, which provides the same indexing functionality.

Getting or setting the value of this property approaches an O(1) operation.

The following code example uses the Item property (the indexer in C#) to retrieve values, demonstrating that a KeyNotFoundException is thrown when a requested key is not present, and showing that the value associated with a key can be replaced.

The example also shows how to use the TryGetValue method as a more efficient way to retrieve values if a program often must try key values that are not in the dictionary.

This code example is part of a larger example provided for the Dictionary(Of TKey, TValue) class.


' The Item property is the default property, so you 
' can omit its name when accessing elements. 
outputBlock.Text &= String.Format("For key = ""rtf"", value = {0}.", _
    openWith("rtf")) & vbCrLf

' The default Item property can be used to change the value
' associated with a key.
openWith("rtf") = "winword.exe"
outputBlock.Text &= String.Format("For key = ""rtf"", value = {0}.", _
    openWith("rtf")) & vbCrLf

' If a key does not exist, setting the default Item property
' for that key adds a new key/value pair.
openWith("doc") = "winword.exe"


...


' The default Item property throws an exception if the requested
' key is not in the dictionary.
Try
   outputBlock.Text &= String.Format("For key = ""tif"", value = {0}.", _
       openWith("tif")) & vbCrLf
Catch
   outputBlock.Text &= "Key = ""tif"" is not found." & vbCrLf
End Try


...


' When a program often has to try keys that turn out not to
' be in the dictionary, TryGetValue can be a more efficient 
' way to retrieve values.
Dim value As String = ""
If openWith.TryGetValue("tif", value) Then
   outputBlock.Text &= String.Format("For key = ""tif"", value = {0}.", value) & vbCrLf
Else
   outputBlock.Text &= "Key = ""tif"" is not found." & vbCrLf
End If


Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Community Additions

ADD
Show:
© 2014 Microsoft