Compartir a través de

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

  • Referencia

Definición

Espacio de nombres:
System.Collections.Generic
Ensamblado:
System.Collections.dll
Ensamblado:
mscorlib.dll
Ensamblado:
netstandard.dll
Source:
Dictionary.cs
Source:
Dictionary.cs
Source:
Dictionary.cs

Obtiene o establece el valor asociado a la clave especificada.

public:
 property TValue default[TKey] { TValue get(TKey key); void set(TKey key, TValue value); };
public TValue this[TKey key] { get; set; }
member this.Item('Key) : 'Value with get, set
Default Public Property Item(key As TKey) As TValue

Parámetros

key
TKey

Clave del valor que se va a obtener o establecer.

Valor de propiedad

TValue

Valor asociado a la clave especificada. Si no se encuentra la clave especificada, en el caso de una operación Get, se producirá una excepción KeyNotFoundException y, en el caso de una operación Set, se creará un nuevo elemento con la clave especificada.

Implementaciones

Item[TKey]

Excepciones

ArgumentNullException

key es null.

KeyNotFoundException

La propiedad se recupera y key no existe en la colección.

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 ejemplo de código es parte de un ejemplo más grande proporcionado para la clase Dictionary<TKey,TValue>. openWith es el nombre del diccionario usado en este ejemplo.

// Create a new dictionary of strings, with string keys.
//
Dictionary<String^, String^>^ openWith =
    gcnew Dictionary<String^, String^>();

// Add some elements to the dictionary. 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 dictionary.
try
{
    openWith->Add("txt", "winword.exe");
}
catch (ArgumentException^)
{
    Console::WriteLine("An element with Key = \"txt\" already exists.");
}

// Create a new dictionary of strings, with string keys.
//
Dictionary<string, string> openWith =
    new Dictionary<string, string>();

// Add some elements to the dictionary. 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 dictionary.
try
{
    openWith.Add("txt", "winword.exe");
}
catch (ArgumentException)
{
    Console.WriteLine("An element with Key = \"txt\" already exists.");
}

' Create a new dictionary of strings, with string keys.
'
Dim openWith As New Dictionary(Of String, String)

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

// 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 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 Item property is the default property, so you 
' can omit its name when accessing elements. 
Console.WriteLine("For key = ""rtf"", value = {0}.", _
    openWith("rtf"))

' The default Item property 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 default Item property
' for that key adds a new key/value pair.
openWith("doc") = "winword.exe"

// 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.");
}

// 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.");
}

' The default Item property throws an exception if the requested
' key is not in the dictionary.
Try
    Console.WriteLine("For key = ""tif"", value = {0}.", _
        openWith("tif"))
Catch 
    Console.WriteLine("Key = ""tif"" is not found.")
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.
String^ value = "";
if (openWith->TryGetValue("tif", value))
{
    Console::WriteLine("For key = \"tif\", value = {0}.", value);
}
else
{
    Console::WriteLine("Key = \"tif\" is not found.");
}

// 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.");
}

' 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
    Console.WriteLine("For key = ""tif"", value = {0}.", value)
Else
    Console.WriteLine("Key = ""tif"" is not found.")
End If

Comentarios

Esta propiedad proporciona la capacidad de acceder a un elemento específico de la colección mediante la siguiente sintaxis de C#: 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 Dictionary<TKey,TValue>. Al establecer el valor de propiedad, si la clave está en Dictionary<TKey,TValue>, el valor asociado a esa clave se reemplaza por el valor asignado. Si la clave no está en Dictionary<TKey,TValue>, la clave y el valor se agregan al diccionario. En cambio, el Add método no modifica los elementos existentes.

Una clave no puede ser null, pero un valor puede ser si el tipo de valor es un tipo TValue de referencia.

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

Obtener o establecer el valor de esta propiedad se aproxima a una operación O(1).

Se aplica a

Consulte también