Item, propriété (objet Collection)

Article
09/12/2008

Mise à jour : novembre 2007

Retourne un élément spécifique d'un objet Collection en fonction de sa position ou de sa clé. Lecture seule.

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

Paramètres

Key
Expression String unique qui spécifie une chaîne clé pouvant être utilisée à la place d'un index positionnel pour accéder à un élément de la collection. Key doit correspondre à l'argument Key spécifié lors de l'ajout de l'élément à la collection.
Index
(A) Expression numérique qui spécifie la position d'un élément de la collection. Index doit être un nombre compris entre 1 et la valeur du Count, propriété (objet Collection) de la collection. Ou (B) une expression Object qui spécifie la position ou chaîne clé d'un élément de la collection.

Exceptions

Type d'exception	Numéro de l'erreur	Condition
ArgumentException	5	Key est non valide ou ne correspond à aucun membre existant de la collection. Index ne peut pas être interprété comme caractère ou données numériques.
IndexOutOfRangeException	9	Le Key a la valeur Nothing. Index ne correspond à aucun membre existant de la collection.

Consultez la colonne « Numéro d'erreur » si vous mettez à niveau des applications Visual Basic 6.0 qui utilisent la gestion des erreurs non structurée. (Vous pouvez comparer le numéro d'erreur par rapport à Number, propriété (objet Err).) Toutefois, lorsque cela est possible, vous devez envisager de remplacer un tel contrôle d'erreur par Vue d'ensemble de la gestion structurée des exceptions pour Visual Basic.

Notes

Si Index est de type Object, la propriété Item essaie de le traiter comme un String, un Char, un tableau Char, ou une valeur entière. Si Item ne peut pas convertir Index en String ou Integer, il lève une exception ArgumentException.

La propriété Item est adoptée par défaut pour toutes les collections. Les lignes de code suivantes sont donc équivalentes.

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

Exemple

Cet exemple utilise la propriété Item pour récupérer une référence à un objet de collection. Elle crée birthdays comme un objet Collection puis récupère l'objet représentant l'anniversaire de Bill, à l'aide de la clé "Bill" comme argument Index.

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

Notez que le premier appel spécifie explicitement la propriété Item, contrairement au second. Les deux appels aboutissent, car la propriété Item est la propriété par défaut pour un objet Collection.