IDictionary<TKey,TValue>.Item[TKey] Propiedad

Definición

Obtiene o establece el elemento con la clave especificada.

C#
public TValue this[TKey key] { get; set; }

Parámetros

key
TKey

La clave del elemento que se obtiene o establece.

Valor de propiedad

TValue

El elemento con la clave especificada.

Excepciones

key es null.

La propiedad se recupera, pero key no se encuentra.

La propiedad está establecida y IDictionary<TKey,TValue> es de solo lectura.

Ejemplos

En el ejemplo de código siguiente se usa la Item[] propiedad (el indizador en C#) para recuperar valores, lo que muestra que se produce una KeyNotFoundException excepción cuando una clave solicitada no está presente y se muestra que se puede reemplazar el valor asociado a una clave.

En el ejemplo también se muestra cómo usar el TryGetValue método como una manera más eficaz de recuperar valores si un programa a menudo debe probar los valores de clave que no están en el diccionario.

Este código forma parte de un ejemplo más grande que se puede compilar y ejecutar. Vea System.Collections.Generic.IDictionary<TKey,TValue>.

C#
// 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";
C#
// The indexer throws an exception if the requested key is
// not in the dictionary.
try
{
    Console.WriteLine("For key = \"tif\", value = {0}.",
        openWith["tif"]);
}
catch (KeyNotFoundException)
{
    Console.WriteLine("Key = \"tif\" is not found.");
}
C#
// 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.
string value = "";
if (openWith.TryGetValue("tif", out value))
{
    Console.WriteLine("For key = \"tif\", value = {0}.", value);
}
else
{
    Console.WriteLine("Key = \"tif\" is not found.");
}

Comentarios

Esta propiedad proporciona la capacidad de acceder a un elemento específico de la colección mediante la sintaxis siguiente: ( myCollection[key]myCollection(key) en Visual Basic).

También puede usar la Item[] propiedad para agregar nuevos elementos estableciendo el valor de una clave que no existe en el diccionario; por ejemplo, myCollection["myNonexistentKey"] = myValue en C# (myCollection("myNonexistentKey") = myValue en Visual Basic). Sin embargo, si la clave especificada ya existe en el diccionario, al establecer la Item[] propiedad se sobrescribe el valor anterior. En cambio, el Add método no modifica los elementos existentes.

Las implementaciones pueden variar en la forma en que determinan la igualdad de objetos; por ejemplo, la List<T> clase usa Comparer<T>.Default, mientras que la Dictionary<TKey,TValue> clase permite al usuario especificar la IComparer<T> implementación que se va a usar para comparar las claves.

El lenguaje C# usa la palabra clave this para definir los indexadores en lugar de implementar la Item[] propiedad . Visual Basic implementa Item[] como propiedad predeterminada, lo que proporciona la misma funcionalidad de indización.

Las implementaciones pueden variar en si permiten key ser null.

Se aplica a

Produto Versións
.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
.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.5, 1.6, 2.0, 2.1
UWP 10.0

Consulte también