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

定義

Collection オブジェクトに要素を追加します。

public void Add(object? Item, string? Key = default, object? Before = default, object? After = default);
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 プロパティの値までの数値である必要があります。 BeforeString式の場合は、参照される要素がコレクションに追加されたときに指定されたキー文字列に対応する必要があります。 BeforeAfterの両方を指定することはできません。

After
Object

このフィールドは省略可能です。 コレクション内の相対位置を指定する式です。 追加する要素は、 After 引数で識別される要素の後にコレクションに配置されます。 Afterが数値式の場合は、1 からコレクションのCount プロパティの値までの数値である必要があります。 AfterString式の場合は、参照される要素がコレクションに追加されたときに指定されたキー文字列に対応する必要があります。 BeforeAfterの両方を指定することはできません。

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

注釈

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

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

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

適用対象