Add 方法(Collection 对象)

更新:2007 年 11 月

将一个元素添加到 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 的集合。若要查看其效果,请创建一个包含两个 Button 控件的 Form,并将控件的 Text 属性分别设置为 Add 和 List。向窗体代码添加 child 类定义和 family 声明。修改所示的 Add 和 List 按钮的 _Click 事件处理程序。使用“Add”(添加)按钮可以添加子级。List 按钮将显示所有子级的名称。

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 对象)