Add (Método, objeto Collection)

Actualización: noviembre 2007

Agrega un elemento a un objeto Collection.

Public Sub Add( _
   ByVal Item As Object, _
   Optional ByVal Key As String, _
   Optional ByVal { Before | After } As Object = Nothing _
)

Parámetros

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

• Key
  Opcional. Expresión String única que especifica una cadena clave que se puede utilizar, en lugar de un índice posicional, para tener acceso a este nuevo elemento de la colección.

• Before
  Opcional. Expresión que especifica una posición relativa dentro de la colección. El elemento que se va a agregar se situará en la colección antes del miembro 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 (Propiedad, objeto Collection) de la colección. Si Before es una expresión String, deberá corresponderse con la cadena clave que se especificó cuando se agregó a la colección el elemento al que se hace referencia. No puede especificar Before y After.

• After
  Opcional. Expresión que especifica una posición relativa dentro de la colección. El elemento que se va a agregar se situará en la colección después del miembro 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 String, deberá corresponderse con la cadena clave que se especificó cuando se agregó a la colección el elemento al que se hace referencia. No puede especificar Before y After.

Excepciones/Códigos de error

Consulte la columna "Número de error" si está actualizando aplicaciones de Visual Basic 6.0 que utilizan el control de errores no estructurado. (Se puede comparar el número de error con respecto a Number (Propiedad, objeto Err)). Sin embargo, siempre que sea posible, debe considerarse la posibilidad de sustituir dicho control de errores por Información general sobre el control estructurado de excepciones de Visual Basic.

Comentarios

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

También se producirá un error en caso de que el valor Key especificado coincida con la clave de un elemento existente en la colección.

Ejemplo

En el ejemplo siguiente se utiliza el método Add para agregar objetos child (instancias de una clase denominada child que contiene una propiedad Publicname) a una colección denominada family. Para ver cómo funciona, cree un control Form con dos controles Button y establezca sus propiedades Text en Agregar y Enumerar. Agregue al código del formulario la definición de clase child y la declaración de family. Modifique los controladores de eventos _Click para los botones Agregar y Enumerar. El botón Agregar le permitirá agregar elementos secundarios. El botón Enumerar 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(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

Requisitos

Espacio de nombres:Microsoft.VisualBasic

**Módulo:**Collection

Ensamblado: Visual Basic Runtime Library (en Microsoft.VisualBasic.dll)

Vea también

Referencia

Collection (Objeto, Visual Basic)

Item (Propiedad, objeto Collection)

Remove (Método, objeto Collection)