Метод Add (объект Collection)

Статья
11/05/2008

Обновлен: Ноябрь 2007

Добавляет элемент в объект Collection.

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

Параметры

Item
Обязательный атрибут. Объект любого типа, определяющий добавляемый в коллекцию элемент.
Key
Необязательный атрибут. Уникальное выражение типа String, задающее ключевую строку, которая может использоваться для доступа к этому элементу коллекции вместо индекса позиции.
Before
Необязательный атрибут. Выражение, задающее относительную позицию в коллекции. Добавляемый элемент помещается в коллекцию перед элементом, определяемым аргументом Before. Если Before является числовым выражением, то оно должно быть числом от 1 до значения Свойство Count (объект Collection) коллекции. Если Before является выражением типа String, то оно должно соответствовать ключевой строке, заданной при добавлении элемента в коллекцию. Нельзя указать одновременно Before и After.
After
Необязательный атрибут. Выражение, задающее относительную позицию в коллекции. Добавляемый элемент помещается в коллекцию после элемента, определяемого аргументом After. Если After является числовым выражением, то оно должно быть числом от 1 до значения Count коллекции. Если After является выражением типа String, то оно должно соответствовать ключевой строке, заданной при добавлении элемента в коллекцию. Нельзя указать одновременно Before и After.

Исключения и коды ошибок

Тип исключения	Номер ошибки	Условия
ArgumentException	5	Before и After заданы одновременно. Аргумент Before или аргумент After ссылается на несуществующий элемент в коллекции. Указанное значение Key уже существует.

См. столбец "Номер ошибки", если выполняется обновление приложений Visual Basic 6.0, в которых используется неструктурированная обработка ошибок. (Можно сравнить номер ошибки с Свойство Number (объект Err).) Однако, по возможности, следует заменять такую систему управления ошибками на Обзор структурной обработки исключений в Visual Basic.

Заметки

Аргументы Before и After должны ссылаться на существующий член коллекции; в противном случае возникнет ошибка.

Ошибка также возникнет, если заданное в аргументе Key значение соответствует ключу существующего элемента коллекции.

Пример

В следующем примере метод Add используется для добавления объектов child — экземпляров класса с именем child, содержащих Public свойство name — в коллекцию с именем family. Чтобы посмотреть на код в действии, создайте Form с двумя элементами управления Button и установите их свойства Text в значения Добавить и Список. В код формы добавьте определение класса child и объявление family. Измените обработчики событий _Click для кнопок Добавить и Список как показано ниже. Кнопка Добавить позволяет добавлять дочерние элементы. Кнопка Список отображает имена всех дочерних элементов.

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

Требования

Пространство имен: Microsoft.VisualBasic

Модуль: Collection

Сборка: Visual Basic (библиотека времени выполнения, в Microsoft.VisualBasic.dll)

См. также

Ссылки

Объект Collection (Visual Basic)

Свойство Item (объект Collection)

Метод Remove (объект Collection)

Поделиться через