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

Definição

Obtém ou define o elemento com a chave especificada.Gets or sets the element with the specified key.

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

A chave do elemento a ser obtida ou adicionada.The key of the element to get or set.

Valor da propriedade

TValue

O elemento com a chave especificada.The element with the specified key.

Exceções

key é null.key is null.

A propriedade é recuperada e key não foi encontrado.The property is retrieved and key is not found.

A propriedade é definida e o IDictionary<TKey,TValue> é somente leitura.The property is set and the IDictionary<TKey,TValue> is read-only.

Exemplos

O exemplo de código a seguir Item[TKey] usa a propriedade (o indexador em C#) para recuperar valores, demonstrando KeyNotFoundException que um é gerado quando uma chave solicitada não está presente e mostrando que o valor associado a uma chave pode ser substituído.The following code example uses the Item[TKey] 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.

O exemplo também mostra como usar o TryGetValue método como uma maneira mais eficiente de recuperar valores se um programa geralmente deve experimentar valores de chave que não estão no dicionário.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.

Esse código é parte de um exemplo maior que pode ser compilado e executado.This code is part of a larger example that can be compiled and executed. Consulte System.Collections.Generic.IDictionary<TKey,TValue>.See System.Collections.Generic.IDictionary<TKey,TValue>.

// 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

Comentários

Essa propriedade fornece a capacidade de acessar um elemento específico na coleção usando a seguinte sintaxe: myCollection[key] (myCollection(key) em Visual Basic).This property provides the ability to access a specific element in the collection by using the following syntax: myCollection[key] (myCollection(key) in Visual Basic).

Você também pode usar a Item[TKey] propriedade para adicionar novos elementos definindo o valor de uma chave que não existe no dicionário; por exemplo, myCollection["myNonexistentKey"] = myValue em C# (myCollection("myNonexistentKey") = myValue em Visual Basic).You can also use the Item[TKey] property to add new elements by setting the value of a key that does not exist in the dictionary; for example, myCollection["myNonexistentKey"] = myValue in C# (myCollection("myNonexistentKey") = myValue in Visual Basic). No entanto, se a chave especificada já existir no dicionário, definir Item[TKey] a propriedade substituirá o valor antigo.However, if the specified key already exists in the dictionary, setting the Item[TKey] property overwrites the old value. Por outro lado, Add o método não modifica os elementos existentes.In contrast, the Add method does not modify existing elements.

As implementações podem variar na forma como determinam a igualdade dos objetos; por exemplo, a List<T> classe usa Comparer<T>.Default, enquanto a Dictionary<TKey,TValue> classe permite que o usuário especifique a IComparer<T> implementação a ser usada para comparar as chaves.Implementations can vary in how they determine equality of objects; for example, the List<T> class uses Comparer<T>.Default, whereas the Dictionary<TKey,TValue> class allows the user to specify the IComparer<T> implementation to use for comparing keys.

O C# idioma usa a palavra-chave this para definir os indexadores em vez Item[TKey] de implementar a propriedade.The C# language uses the this keyword to define the indexers instead of implementing the Item[TKey] property. Visual Basic implementa Item[TKey] como uma propriedade padrão, que fornece a mesma funcionalidade de indexação.Visual Basic implements Item[TKey] as a default property, which provides the same indexing functionality.

As implementações podem variar se permitirem key. nullImplementations can vary in whether they allow key to be null.

Aplica-se a

Veja também