Collection.Add(Object, String, Object, Object) Método

Definición

Espacio de nombres:

Microsoft.VisualBasic

Ensamblado:

Microsoft.VisualBasic.Core.dll

Source:

Collection.vb

Agrega un elemento a un objeto Collection.

public void Add (object? Item, string? Key = default, object? Before = default, object? After = default);

member this.Add : obj * string * obj * obj -> unit

Public Sub Add (Item As Object, Optional Key As String = Nothing, Optional Before As Object = Nothing, Optional After As Object = Nothing)

Parámetros

Item

Object

Obligatorio. Objeto de cualquier tipo que especifica el elemento que se va a agregar a la recopilación.

Key

String

Opcional. Expresión única de tipo String que especifica una cadena de clave que se puede utilizar en lugar de un índice de posición para obtener acceso a este nuevo elemento de la colección.

Before

Object

Opcional. Expresión que especifica una posición relativa en la colección. El elemento que se va a agregar se coloca en la colección delante del elemento identificado por el argumento Before. Si Before es una expresión numérica, debe ser un número comprendido entre 1 y el valor de la propiedad Count de la colección. Si Before es una expresión de tipo String, debe corresponder a la cadena de clave especificada cuando se agregó a la colección el elemento al que se hace referencia. No se pueden especificar los dos parámetros Before y After.

After

Object

Opcional. Expresión que especifica una posición relativa en la colección. El elemento que se va a agregar se coloca en la colección detrás del elemento identificado por el argumento After. Si After es una expresión numérica, debe ser un número comprendido entre 1 y el valor de la propiedad Count de la colección. Si After es una expresión de tipo String, debe corresponder a la cadena de clave especificada cuando se agregó a la colección el elemento al que se hace referencia. No se pueden especificar los dos parámetros Before y After.

Ejemplos

En el ejemplo siguiente se usa el Add método para agregar child objetos ( instancias de una clase denominada child que contiene una Public propiedad name ) a una colección denominada family. Para ver cómo funciona, cree un Form objeto con dos Button controles y establezca sus Text propiedades Add en y List. Agregue la definición de child clase y la family declaración al código de formulario. Modifique los _Click controladores de eventos para los botones Agregar y Lista , tal y como se muestra. El botón Agregar permite agregar elementos secundarios. El botón Lista muestra los nombres de todos los elementos secundarios.

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() 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() Handles Button2.Click
    For Each aChild As child In family
        MsgBox(aChild.name)
    Next
End Sub

Comentarios

El Before argumento o After debe hacer referencia a un elemento existente de la colección; de lo contrario, se produce un error.

Si se omiten los Before argumentos y After , el nuevo objeto se agrega al final de la colección.

También se produce un error si un valor especificado Key coincide con la clave de un elemento existente de la colección.