Item プロパティ (Collection オブジェクト)

[アーティクル]
09/30/2008

更新 : 2007 年 11 月

指定した位置またはキーに対応する Collection オブジェクトの要素を返します。読み取り専用です。

Default Public ReadOnly Property Item( _
    ByVal { Key As String | Index As Integer | Index As Object } _
) As Object

パラメータ

Key
コレクションの要素へアクセスするために使用できる、(位置を示すインデックスではなく) キー文字列を指定する一意な String 式です。Key は、コレクションに要素を追加するときに指定した Key 引数と一致している必要があります。
Index
以下の (A) または (B) です。(A) コレクションの要素の位置を指定する数式です。Index は 1 からコレクションの Count プロパティ (Collection オブジェクト) までの値であることが必要です。(B) コレクションの要素の位置またはキー文字列を指定する Object 式です。

例外

例外の種類	エラー番号	条件
ArgumentException	5	Key が無効、またはコレクションの既存の要素のいずれにも一致しません。 Index を文字データまたは数値データに解釈できません。
IndexOutOfRangeException	9	Key が Nothing です。 Index がコレクションの既存の要素のいずれにも一致しません。

非構造化エラー処理を使用する Visual Basic 6.0 アプリケーションをアップグレードする場合は、"エラー番号" の列を参照してください(エラー番号を Number プロパティ (Err オブジェクト) と比較することもできます)。ただし、可能であれば、このようなエラー制御は Visual Basic の構造化例外処理の概要に置き換えることを検討してください。

解説

Index の型が Object の場合、Item プロパティはこれを String、Char、Char 配列、または整数値として扱うことを試みます。Index を String や Integer に変換できなければ、Item は ArgumentException 例外をスローします。

Item プロパティは、コレクションの既定のプロパティです。したがって、次の 2 つのコード行は同じになります。

MsgBox(CStr(customers.Item(1)))
MsgBox(CStr(customers(1)))

使用例

Item プロパティを使って、コレクションに含まれるオブジェクトへの参照を取得する例を次に示します。birthdays を Collection オブジェクトとして作成し、Index 引数に "Bill" というキーを指定して、Bill の誕生日を表すオブジェクトを取得します。

Dim birthdays As New Collection()
birthdays.Add(New DateTime(2001, 1, 12), "Bill")
birthdays.Add(New DateTime(2001, 1, 13), "Joe")
birthdays.Add(New DateTime(2001, 1, 14), "Mike")
birthdays.Add(New DateTime(2001, 1, 15), "Pete")


...


Dim aBirthday As DateTime
aBirthday = birthdays.Item("Bill")
MsgBox(CStr(aBirthday))
aBirthday = birthdays("Bill")
MsgBox(CStr(aBirthday))

最初の呼び出しでは Item プロパティが明示的に指定されていますが、2 回目の呼び出しでは明示的に指定されていないことに注意してください。Collection オブジェクトでは、Item プロパティが既定となるため、いずれの呼び出し方法でも同じ結果になります。