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

Definição

Obtém ou define o valor associado à chave especificada.Gets or sets the value associated 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 TKey TKey TKey

A chave do valor a ser obtido ou definido.The key of the value to get or set.

Valor da propriedade

TValue TValue TValue TValue

O valor associado à chave especificada.The value associated with the specified key. Se a chave especificada não for encontrada, uma operação get lançará um KeyNotFoundException e uma operação set criará um novo elemento com a chave especificada.If the specified key is not found, a get operation throws a KeyNotFoundException, and a set operation creates a new element with the specified key.

Implementações

Exceções

A propriedade é recuperada e key não existe na coleção.The property is retrieved and key does not exist in the collection.

Exemplos

Observação

Alguns dos exemplos de C# neste artigo são executados no executador de código embutido Try.NET e no playground.Some of the C# examples in this article run in the Try.NET inline code runner and playground. Quando presente, selecione o botão Executar para executar um exemplo em uma janela interativa.When present, select the Run button to run an example in an interactive window. Ao executar o código, é possível modificá-lo e executar o código modificado clicando em Executar novamente.Once you execute the code, you can modify it and run the modified code by selecting Run again. O código modificado será executado na janela interativa ou, se a compilação falhar, a janela interativa exibirá todos as mensagens de erro do compilador C#.The modified code either runs in the interactive window or, if compilation fails, the interactive window displays all C# compiler error messages.

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.

Este exemplo de código faz parte de um exemplo maior fornecido para Dictionary<TKey,TValue> a classe.This code example is part of a larger example provided for the Dictionary<TKey,TValue> class. openWithé o nome do dicionário usado neste exemplo.openWith is the name of the Dictionary used in this example.

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

Comentários

Essa propriedade fornece a capacidade de acessar um elemento específico na coleção usando a seguinte C# 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 C# 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 Dictionary<TKey,TValue>no.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<TKey,TValue>. Quando você definir o valor da propriedade, se a chave estiver no Dictionary<TKey,TValue>, o valor associado a essa chave será substituído pelo valor atribuído.When you set the property value, if the key is in the Dictionary<TKey,TValue>, the value associated with that key is replaced by the assigned value. Se a chave não estiver no Dictionary<TKey,TValue>, a chave e o valor serão adicionados ao dicionário.If the key is not in the Dictionary<TKey,TValue>, the key and value are added to the dictionary. Por outro lado, Add o método não modifica os elementos existentes.In contrast, the Add method does not modify existing elements.

Uma chave não pode nullser, mas um valor pode ser, se o tipo TValue de valor for um tipo de referência.A key cannot be null, but a value can be, if the value type TValue is a reference type.

O C# idioma usa a this palavra-chave 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.

Obter ou definir o valor dessa propriedade se aproxima de uma operação O (1).Getting or setting the value of this property approaches an O(1) operation.

Aplica-se a

Veja também