SortedDictionary.Item プロパティ

.NET Framework クラス ライブラリ リファレンス

SortedDictionary.Item プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

指定したキーに関連付けられている値を取得または設定します。

名前空間: System.Collections.Generic
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Default Property
 Item ( _
    key As TKey _
) As TValue

Visual Basic (使用法)

Dim instance As SortedDictionary(Of
 TKey, TValue)
Dim key As TKey
Dim value As TValue

value = instance(key)

instance(key) = value

C#

public TValue this [
    TKey key
] { get; set; }

C++

public:
virtual property TValue default [TKey] {
    TValue get (TKey key) sealed;
    void set (TKey key, TValue value) sealed;
}

J#

/** @property */
public final TValue get_Item (TKey key)

/** @property */
public final void set_Item (TKey key, TValue
 value)

JScript

JScript では、インデックス付きのプロパティは使用できますが、新規に宣言することはできません。.

パラメータ

key

取得または設定する値のキー。

プロパティ値
指定したキーに関連付けられている値。指定したキーが見つからなかった場合、get 操作は KeyNotFoundException をスローし、set 操作は指定したキーを持つ新しい要素を作成します。

例外

例外の種類	条件
ArgumentNullException	key が null 参照 (Visual Basic では Nothing) です。
KeyNotFoundException	プロパティが取得されましたが、コレクション内に key が存在しません。

解説

このプロパティを使用すると、C# の myCollection[key] (Visual Basic では myCollection(key)) という構文を使用して、コレクション内の特定の要素にアクセスできます。

Item プロパティを使用すると、SortedDictionary 内に存在しないキーの値を設定することで、新しい要素を追加することもできます (例 : myCollection["myNonexistentKey"] = myValue)。ただし、指定したキーが SortedDictionary 内に既に存在する場合、Item プロパティを設定すると既存の値が上書きされます。対照的に、Add メソッドは既存の要素を変更しません。

キーを null 参照 (Visual Basic では Nothing) にすることはできませんが、値の型 TValue が参照型である場合、値を null にすることはできます。

このプロパティ値を取得することは、O(log n) 操作になります。また、このプロパティを設定することも O(log n) 操作になります。

使用例

次のコード例では、Item プロパティ (C# ではインデクサ) を使用して値を取得し、要求されたキーが存在しないときに KeyNotFoundException がスローされる例を示し、またキーに関連付けられた値が置き換えられることも示します。

また、この例では、プログラムがディクショナリにないキー値を頻繁に試行する必要がある場合に、より効率的に値を取得する方法として TryGetValue メソッドを使用する方法も示します。

このコード例は、SortedDictionary クラスのトピックで取り上げているコード例の一部分です。

Visual Basic

' 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

C#

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
SortedDictionary ジェネリック クラス
SortedDictionary メンバ
System.Collections.Generic 名前空間
SortedDictionary.Add メソッド