Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

SortedDictionary.System.Collections.IDictionary.Item Property

Gets or sets the element with the specified key.

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

Object IDictionary.this [
	Object key
] { get; set; }
Not applicable.

Parameters

key

The key of the element to get.

Property Value

The element with the specified key, or a null reference (Nothing in Visual Basic) if key is not in the dictionary or key is of a type that is not assignable to the key type TKey of the SortedDictionary.
Exception typeCondition

ArgumentNullException

key is a null reference (Nothing in Visual Basic).

ArgumentException

A value is being assigned, and key is of a type that is not assignable to the key type TKey of the SortedDictionary.

-or-

A value is being assigned, and value is of a type that is not assignable to the value type TValue of the SortedDictionary.

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; 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.

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

Getting the value of this property is an O(log n) operation; setting the property is also an O(log n) operation.

The following code example shows how to use the System.Collections.IDictionary.Item property (the indexer in C#) of the System.Collections.IDictionary interface with a SortedDictionary, and ways the property differs from the SortedDictionary.Item property.

The example shows that, like the SortedDictionary.Item property, the SortedDictionary.System.Collections.IDictionary.Item property can change the value associated with an existing key and can be used to add a new key/value pair if the specified key is not in the dictionary. The example also shows that unlike the SortedDictionary.Item property, the SortedDictionary.System.Collections.IDictionary.Item property does not throw an exception if key is not in the dictionary, returning a null reference instead. Finally, the example demonstrates that getting the SortedDictionary.System.Collections.IDictionary.Item property returns a null reference if key is not the correct data type, and that setting the property throws an exception if key is not the correct data type.

The code example is part of a larger example, including output, provided for the System.Collections.IDictionary.Add method.

using System;
using System.Collections;
using System.Collections.Generic;

public class Example
{
    public static void Main()
    {
        // Create a new sorted dictionary of strings, with string keys,
        // and access it using the IDictionary interface.
        //
        IDictionary openWith = new SortedDictionary<string, string>();

        // Add some elements to the dictionary. There are no 
        // duplicate keys, but some of the values are duplicates.
        // IDictionary.Add throws an exception if incorrect types
        // are supplied for key or value.
        openWith.Add("txt", "notepad.exe");
        openWith.Add("bmp", "paint.exe");
        openWith.Add("dib", "paint.exe");
        openWith.Add("rtf", "wordpad.exe");

	...

        // The Item property is another name for the indexer, so you 
        // can omit its name when accessing elements. 
        Console.WriteLine("For key = \"rtf\", value = {0}.", 
            openWith["rtf"]);

        // The indexer can be used to change the value associated
        // with a key.
        openWith["rtf"] = "winword.exe";
        Console.WriteLine("For key = \"rtf\", value = {0}.", 
            openWith["rtf"]);

        // If a key does not exist, setting the indexer for that key
        // adds a new key/value pair.
        openWith["doc"] = "winword.exe";

        // The indexer returns null if the key is of the wrong data 
        // type.
        Console.WriteLine("The indexer returns null" 
            + " if the key is of the wrong type:");
        Console.WriteLine("For key = 2, value = {0}.", 
            openWith[2]);

        // The indexer throws an exception when setting a value
        // if the key is of the wrong data type.
        try
        {
            openWith[2] = "This does not get added.";
        }
        catch (ArgumentException)
        {
            Console.WriteLine("A key of the wrong type was specified" 
                + " when assigning to the indexer.");
        }

	...

        // Unlike the default Item property on the Dictionary class
        // itself, IDictionary.Item does not throw an exception
        // if the requested key is not in the dictionary.
        Console.WriteLine("For key = \"tif\", value = {0}.", 
            openWith["tif"]);

	...

    }
}

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.