Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IDictionary.Item Property

Gets or sets the element with the specified key.

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

Object this[
	Object key
] { get; set; }

Parameters

key
Type: System.Object
The key of the element to get or set.

Property Value

Type: System.Object
The element with the specified key.

ExceptionCondition
ArgumentNullException

key is null.

NotSupportedException

The property is set and the IDictionary object is read-only.

-or-

The property is set, key does not exist in the collection, and the IDictionary has a fixed size.

This property provides the ability to access a specific element in the collection by using the following syntax: myCollection[key].

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 (for example, myCollection["myNonexistentKey"] = myValue). However, if the specified key already exists in the dictionary, setting the Item property overwrites the old value. In contrast, the Add method does not modify existing elements.

Implementations can vary in whether they allow the key to be null.

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.

The following code example demonstrates how to implement the Item property. This code example is part of a larger example provided for the IDictionary class.


public object this[object key]
{
   get
   {
      // If this key is in the dictionary, return its value.
      Int32 index;
      if (TryGetIndexOfKey(key, out index))
      {
         // The key was found; return its value.
         return items[index].Value;
      }
      else
      {
         // The key was not found; return null.
         return null;
      }
   }

   set
   {
      // If this key is in the dictionary, change its value. 
      Int32 index;
      if (TryGetIndexOfKey(key, out index))
      {
         // The key was found; change its value.
         items[index].Value = value;
      }
      else
      {
         // This key is not in the dictionary; add this key/value pair.
         Add(key, value);
      }
   }
}


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

Show:
© 2014 Microsoft