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

Definição

Namespace:

Microsoft.VisualBasic

Assembly:

Microsoft.VisualBasic.Core.dll

Origem:

Collection.vb

Adiciona um elemento a um 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

Obrigatórios. Um objeto de qualquer tipo que especifica o elemento a ser adicionado à coleção.

Key

String

Opcional. Uma expressão String exclusiva, que especifica uma cadeia de caracteres chave que pode ser usada em vez de um índice posicional, para acessar esse novo elemento na coleção.

Before

Object

Opcional. Uma expressão que especifica uma posição relativa na coleção. O elemento a ser adicionado é colocado na coleção antes do elemento identificado pelo argumento Before. Se Before for uma expressão numérica, ele deverá ser um número entre 1 e o valor da propriedade Count da coleção. Se Before for uma expressão String, ele deverá corresponder à cadeia de caracteres de chave especificada quando o elemento que está sendo referenciado foi adicionado à coleção. Não é possível especificar Before e After.

After

Object

Opcional. Uma expressão que especifica uma posição relativa na coleção. O elemento a ser adicionado é colocado na coleção após o elemento identificado pelo argumento After. Se After for uma expressão numérica, ele deverá ser um número entre 1 e o valor da propriedade Count da coleção. Se After for uma expressão String, ele deverá corresponder à cadeia de caracteres de chave especificada quando o elemento referenciado foi adicionado à coleção. Não é possível especificar Before e After.

Exemplos

O exemplo a seguir usa o Add método para adicionar child objetos – instâncias de uma classe chamada child que contém uma Public propriedade name – a uma coleção chamada family. Para ver como isso funciona, crie um Form com dois Button controles e defina suas Text propriedades Add como e List. Adicione a child definição de classe e a family declaração ao código do formulário. Modifique os _Click manipuladores de eventos para os botões Adicionar e Lista , conforme mostrado. O botão Adicionar permite adicionar filhos. O botão Lista exibe os nomes de todos os filhos.

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

Comentários

O Before argumento ou After deve se referir a um elemento existente da coleção; caso contrário, ocorrerá um erro.

Se os Before argumentos e After forem omitidos, o novo objeto será adicionado ao final da coleção.

Um erro também ocorrerá se um valor especificado Key corresponder à chave de um elemento existente da coleção.