Collection.Add, méthode

Article
08/21/2007

Ajoute un élément à l'objet Collection.

Espace de noms : Microsoft.VisualBasic
Assembly : Microsoft.VisualBasic (dans microsoft.visualbasic.dll)

Syntaxe

'Déclaration
Public Sub Add ( _
    Item As Object, _
    <OptionalAttribute> Optional Key As String = Nothing, _
    <OptionalAttribute> Optional Before As Object = Nothing, _
    <OptionalAttribute> Optional After As Object = Nothing _
)
'Utilisation
Dim instance As Collection
Dim Item As Object
Dim Key As String
Dim Before As Object
Dim After As Object

instance.Add(Item, Key, Before, After)

public void Add (
    Object Item,
    [OptionalAttribute] string Key,
    [OptionalAttribute] Object Before,
    [OptionalAttribute] Object After
)

public:
void Add (
    Object^ Item, 
    [OptionalAttribute] String^ Key, 
    [OptionalAttribute] Object^ Before, 
    [OptionalAttribute] Object^ After
)

public void Add (
    Object Item, 
    /** @attribute OptionalAttribute() */ String Key, 
    /** @attribute OptionalAttribute() */ Object Before, 
    /** @attribute OptionalAttribute() */ Object After
)

public function Add (
    Item : Object, 
    Key : String, 
    Before : Object, 
    After : Object
)

Paramètres

Item
Obligatoire. Objet de tout type qui spécifie les erreurs à ajouter à la collection.

Key
Facultatif. Expression String unique qui spécifie une chaîne clé qui peut être utilisée au lieu d'un index de position pour accéder à ce nouvel élément dans la collection.

Before
Facultatif. Expression qui spécifie une position relative dans la collection. L'élément à ajouter est placé dans la collection avant l'élément identifié par l'argument Before. Si Before est une expression numérique, ce doit être un nombre entre 1 et la valeur de Count, propriété (objet Collection) de la collection. Si Before est une expression String, il doit correspondre à la chaîne clé spécifiée au moment où l'élément auquel il est fait référence a été ajouté à la collection. Vous ne pouvez pas spécifier Before et After.

After
Facultatif. Expression qui spécifie une position relative dans la collection. L'élément à ajouter est placé dans la collection après l'élément identifié par l'argument After. Si After est une expression numérique, ce doit être un nombre entre 1 et la valeur de la propriété Count de la collection. Si After est une expression String, il doit correspondre à la chaîne clé spécifiée au moment où l'élément auquel il est fait référence a été ajouté à la collection. Vous ne pouvez pas spécifier Before et After.

Notes

Pour plus d'informations, consultez la rubrique Visual Basic Add, méthode (objet Collection).

L'argument Before ou After doit faire référence à un élément existant de la collection ; sinon, une erreur se produit.

Une erreur se produit également si une valeur Key spécifiée correspond à la clé pour un élément existant de la collection.

Exemple

L'exemple suivant utilise la méthode Add pour ajouter des objets child (des instances d'une classe appelée child contenant une propriété namePublic) à une collection appelée family. Pour voir comment cela fonctionne, créez un Form avec deux contrôles Button et définissez leurs propriétés Text aux valeurs Add et List. Ajoutez la définition de classe child et la déclaration family au code du formulaire. Modifiez les gestionnaires d'événements _Click des boutons Ajouter et Liste, comme indiqué. Le bouton Ajouter vous permet d'ajouter des enfants. Le bouton Liste affiche les noms de tous les enfants.

Public Class child
    Public name As String
    Sub New(ByVal newName As String)
        name = newName
    End Sub
End Class
' Create a Collection object.
Private family As New Collection()
Private Sub addChild_Click(ByVal sender As System.Object, _
    ByVal e As System.EventArgs) Handles Button1.Click
    Dim newName As String
    newName = InputBox("Name of new family member: ")
    If newName <> "" Then
        family.Add(New child(newName), newName)
    End If
End Sub
Private Sub listChild_Click(ByVal sender As System.Object, _
    ByVal e As System.EventArgs) Handles Button2.Click
    For Each aChild As child In family
        MsgBox(aChild.name)
    Next
End Sub

Plates-formes

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile pour Pocket PC, Windows Mobile pour Smartphone, Windows Server 2003, Windows XP Édition Media Center, Windows XP Professionnel Édition x64, Windows XP SP2, Windows XP Starter Edition

Le .NET Framework ne prend pas en charge toutes les versions de chaque plate-forme. Pour obtenir la liste des versions prises en charge, consultez Configuration requise.

Informations de version

.NET Framework

Prise en charge dans : 2.0, 1.1, 1.0

.NET Compact Framework

Prise en charge dans : 2.0, 1.0

Voir aussi

Référence

Collection, classe
Membres Collection
Microsoft.VisualBasic, espace de noms

Autres ressources

Add, méthode (objet Collection)
Collection, objet (Visual Basic)
Item, propriété (objet Collection)
Remove, méthode (objet Collection)

Partager via