Collection.Add(Object, String, Object, Object) メソッド

定義

名前空間:

Microsoft.VisualBasic

アセンブリ:

Microsoft.VisualBasic.Core.dll

ソース:

Collection.vb

要素を 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)

パラメーター

Item

Object

必須です。 コレクションに追加する要素を示す任意の型のオブジェクトです。

Key

String

省略可能。 コレクション内の新しい要素にアクセスするときに位置インデックスの代わりに使用できるキー文字列を指定する、一意の String 型の式。

Before

Object

省略可能。 コレクション内の位置を相対的に示す式。 追加される要素は、コレクション内で Before 引数によって識別された要素の前に配置されます。 Before が数式である場合、値の範囲は 1 以上でコレクションの Count プロパティ値以下である必要があります。 Before が String 型の式である場合は、参照される要素がコレクションに追加されたときに指定されたキー文字列に対応する必要があります。 Before と After の両方を指定することはできません。

After

Object

省略可能。 コレクション内の位置を相対的に示す式。 追加される要素は、コレクション内で After 引数によって識別された要素の後に配置されます。 After が数式である場合、値の範囲は 1 以上でコレクションの Count プロパティ値以下である必要があります。 After が String 型の式である場合は、参照される要素がコレクションに追加されたときに指定されたキー文字列に対応する必要があります。 Before と After の両方を指定することはできません。

例

次の例では、Add メソッドを使用して、child オブジェクト (Public プロパティ name を含む、child クラスのインスタンス) を family というコレクションに追加します。 この動作を確認するには、2 つの 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() 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

注釈

または After 引数はBefore、コレクションの既存の要素を参照する必要があります。それ以外の場合は、エラーが発生します。

Before と After 引数の両方を省略すると、新しいオブジェクトはコレクションの末尾に追加されます。

指定した Key 値が、コレクションの既存の要素のキーと一致する場合にも、エラーが発生します。