IDictionary<TKey,TValue>.Item[TKey] Свойство
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Возвращает или задает элемент с указанным ключом.
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
Ключ элемента для получения или задания.
Значение свойства
Элемент с указанным ключом.
Исключения
key равно null.
Свойство извлекается и key не найдено.
Свойство задано и IDictionary<TKey,TValue> доступно только для чтения.
Примеры
В следующем примере кода свойство (индексатор в C#) используется Item[] для получения значений, демонстрируя, что KeyNotFoundException возникает, когда запрошенный ключ отсутствует, и показывает, что значение, связанное с ключом, можно заменить.
В примере также показано, как использовать TryGetValue метод в качестве более эффективного способа получения значений, если программа часто должна попробовать значения ключей, которые не находятся в словаре.
Этот код является частью более крупного примера, который можно скомпилировать и выполнить. См. 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 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 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", 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).
Для добавления новых элементов можно также использовать свойство Item[], задав значение ключа, который не существует в словаре; например, myCollection["myNonexistentKey"] = myValue в C# (myCollection("myNonexistentKey") = myValue в Visual Basic). Однако если указанный ключ уже существует в словаре, установка Item[] свойства перезаписывает старое значение. Напротив, Add метод не изменяет существующие элементы.
Реализации могут отличаться в том, как они определяют равенство объектов; Например, класс используетList<T>, Comparer<T>.Default в то время как Dictionary<TKey,TValue> класс позволяет пользователю указать реализацию, используемую IComparer<T> для сравнения ключей.
Язык C# использует это ключевое слово для определения индексаторов вместо реализации Item[] свойства. Visual Basic реализует Item[] как свойство по умолчанию, которое предоставляет те же функции индексирования.
Реализации могут различаться в зависимости от того, разрешено key ли они быть null.