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

Определение

Возвращает или задает элемент с указанным ключом.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

Параметры

key
TKey TKey TKey TKey

Ключ элемента, который требуется получить или задать.The key of the element to get or set.

Значение свойства

TValue TValue TValue TValue

Элемент с указанным ключом.The element with the specified key.

Исключения

Свойство key имеет значение null.key is null.

Свойство получено и параметр key не найден.The property is retrieved and key is not found.

Свойство задано, и список IDictionary<TKey,TValue> доступен только для чтения.The property is set and the IDictionary<TKey,TValue> is read-only.

Примеры

В следующем примере кода Item[TKey] свойство (индексатор в C#) используется для извлечения значений, что KeyNotFoundException демонстрирует, что исключение возникает, если запрошенный ключ отсутствует, и показывает, что значение, связанное с ключом, можно заменить.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.

В примере также показано, как использовать TryGetValue метод как более эффективный способ извлечения значений, если программа часто должна использовать значения ключей, которых нет в словаре.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.

Этот код является частью более крупного примера, который может быть скомпилирован и выполнен.This code is part of a larger example that can be compiled and executed. См. раздел 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

Комментарии

Это свойство предоставляет возможность доступа к определенному элементу в коллекции с помощью следующего синтаксиса: myCollection[key] (myCollection(key) в 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).

Можно также использовать Item[TKey] свойство для добавления новых элементов, задав значение ключа, который не существует в словаре, myCollection["myNonexistentKey"] = myValue например в C# (myCollection("myNonexistentKey") = myValue в 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). Однако если указанный ключ уже существует в словаре, установка Item[TKey] свойства перезаписывает старое значение.However, if the specified key already exists in the dictionary, setting the Item[TKey] property overwrites the old value. В отличие от этого Add , метод не изменяет существующие элементы.In contrast, the Add method does not modify existing elements.

Реализации могут различаться в зависимости от того, как они определяют равенство объектов; Например, List<T> класс использует Comparer<T>.Default, тогда как Dictionary<TKey,TValue> класс позволяет пользователю указать IComparer<T> реализацию, используемую для сравнения ключей.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.

Язык использует ключевое слово this для определения индексаторов вместо реализации Item[TKey] свойства. C#The C# language uses the this keyword to define the indexers instead of implementing the Item[TKey] property. В языке Visual Basic в качестве свойства по умолчанию реализовано свойство Item[TKey], предоставляющее те же возможности индексирования.Visual Basic implements Item[TKey] as a default property, which provides the same indexing functionality.

Реализации могут различаться в зависимости от того key null, разрешены ли они.Implementations can vary in whether they allow key to be null.

Применяется к

Дополнительно