Collection.Add

.NET Framework クラス ライブラリ リファレンス

Collection.Add メソッド

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

名前空間: Microsoft.VisualBasic
アセンブリ: Microsoft.VisualBasic (microsoft.visualbasic.dll 内)
構文

Visual Basic (宣言)

Public Sub Add ( _
    Item As Object, _
    <OptionalAttribute> Optional Key As
 String = Nothing, _
    <OptionalAttribute> Optional Before As
 Object = Nothing, _
    <OptionalAttribute> Optional After As
 Object = Nothing _
)

Visual Basic (使用法)

Dim instance As Collection
Dim Item As Object
Dim Key As String
Dim Before As Object
Dim After As Object

instance.Add(Item, Key, Before, After)

C#

public void Add (
    Object Item,
    [OptionalAttribute] string Key,
    [OptionalAttribute] Object Before,
    [OptionalAttribute] Object After
)

C++

public:
void Add (
    Object^ Item, 
    [OptionalAttribute] String^ Key, 
    [OptionalAttribute] Object^ Before, 
    [OptionalAttribute] Object^ After
)

J#

public void Add (
    Object Item, 
    /** @attribute OptionalAttribute() */ String Key, 
    /** @attribute OptionalAttribute() */ Object Before, 
    /** @attribute OptionalAttribute() */ Object After
)

JScript

public function Add (
    Item : Object, 
    Key : String, 
    Before : Object, 
    After : Object
)

パラメータ

Item

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

Key

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

Before

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

After

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

解説

詳細については、Visual Basic のトピック「Add メソッド (Collection オブジェクト)」を参照してください。

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

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

使用例

Add メソッドを使用して、child オブジェクト (Public プロパティ name を格納する child というクラスのインスタンス) を family というコレクションに追加する例を次に示します。この例がどのように動作するかを確認するには、2 つの Button コントロールを持つ Form を作成し、それぞれの Text プロパティを Add および List に設定します。child クラス定義および family 宣言をフォーム コードに追加します。[Add] ボタンと [List] ボタンの _Click イベント ハンドラを次のように変更します。[Add] ボタンは、子を追加するときに使用します。[List] ボタンは、すべての子の名前を表示するときに使用します。

Visual Basic

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
Collection クラス
Collection メンバ
Microsoft.VisualBasic 名前空間
その他の技術情報
Add メソッド (Collection オブジェクト)
Collection オブジェクト (Visual Basic)
Item プロパティ (Collection オブジェクト)
Remove メソッド (Collection オブジェクト)

Collection.Add メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

Collection の末尾にオブジェクトを追加します。

名前空間: System.Collections.ObjectModel
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Public Sub Add ( _
    item As T _
)

Visual Basic (使用法)

Dim instance As Collection(Of
 T)
Dim item As T

instance.Add(item)

C#

public void Add (
    T item
)

C++

public:
virtual void Add (
    T item
) sealed

J#

public final void Add (
    T item
)

JScript

public final function Add (
    item : T
)

パラメータ

item

Collection の末尾に追加するオブジェクト。参照型の場合、null 参照 (Visual Basic では Nothing) の値を使用できます。

解説

Collection は、null 参照 (Visual Basic では Nothing) を参照型に対して有効な値として受け取り、要素の重複を許可します。

このメソッドは O(1) 操作です。

使用例

Collection が備える多数のプロパティとメソッドを使用した例を次に示します。このコード例では、文字列のコレクションを作成し、Add メソッドを使用していくつかの文字列を追加し、Count を表示して、文字列を一覧表示します。IndexOf メソッドを使用して文字列のインデックスを検索し、Contains メソッドを使用して文字列がコレクションにあるかどうかを判断します。Insert メソッドを使用して文字列を挿入し、既定の Item プロパティ (C# の場合はインデクサ) を使用して文字列を取得および設定します。文字列 ID による文字列の削除のために Remove メソッドを使用し、インデックスによる文字列の削除のために RemoveAt メソッドを使用します。最後に、Clear メソッドを使用してコレクションのすべての文字列をクリアします。

Visual Basic

Imports System
Imports System.Collections.Generic
Imports System.Collections.ObjectModel

Public Class Demo
    
    Public Shared Sub Main()
 

        Dim dinosaurs As New
 Collection(Of String)

        dinosaurs.Add("Psitticosaurus")
        dinosaurs.Add("Caudipteryx")
        dinosaurs.Add("Compsognathus")
        dinosaurs.Add("Muttaburrasaurus")

        Console.WriteLine("{0} dinosaurs:", dinosaurs.Count)
        Display(dinosaurs)
    
        Console.WriteLine(vbLf & "IndexOf(""Muttaburrasaurus""):
 {0}", _
            dinosaurs.IndexOf("Muttaburrasaurus"))

        Console.WriteLine(vbLf & "Contains(""Caudipteryx""):
 {0}", _
            dinosaurs.Contains("Caudipteryx"))

        Console.WriteLine(vbLf & "Insert(2, ""Nanotyrannus"")")
        dinosaurs.Insert(2, "Nanotyrannus")
        Display(dinosaurs)

        Console.WriteLine(vbLf & "dinosaurs(2): {0}",
 dinosaurs(2))

        Console.WriteLine(vbLf & "dinosaurs(2) = ""Microraptor""")
        dinosaurs(2) = "Microraptor"
        Display(dinosaurs)

        Console.WriteLine(vbLf & "Remove(""Microraptor"")")
        dinosaurs.Remove("Microraptor")
        Display(dinosaurs)

        Console.WriteLine(vbLf & "RemoveAt(0)")
        dinosaurs.RemoveAt(0)
        Display(dinosaurs)
 
        Console.WriteLine(vbLf & "dinosaurs.Clear()")
        dinosaurs.Clear()
        Console.WriteLine("Count: {0}", dinosaurs.Count)

    End Sub
    
    Private Shared Sub Display(ByVal
 cs As Collection(Of String))
 
        Console.WriteLine()
        For Each item As
 String In cs
            Console.WriteLine(item)
        Next item
    End Sub
End Class

' This code example produces the following output:
'
'4 dinosaurs:
'
'Psitticosaurus
'Caudipteryx
'Compsognathus
'Muttaburrasaurus
'
'IndexOf("Muttaburrasaurus"): 3
'
'Contains("Caudipteryx"): True
'
'Insert(2, "Nanotyrannus")
'
'Psitticosaurus
'Caudipteryx
'Nanotyrannus
'Compsognathus
'Muttaburrasaurus
'
'dinosaurs(2): Nanotyrannus
'
'dinosaurs(2) = "Microraptor"
'
'Psitticosaurus
'Caudipteryx
'Microraptor
'Compsognathus
'Muttaburrasaurus
'
'Remove("Microraptor")
'
'Psitticosaurus
'Caudipteryx
'Compsognathus
'Muttaburrasaurus
'
'RemoveAt(0)
'
'Caudipteryx
'Compsognathus
'Muttaburrasaurus
'
'dinosaurs.Clear()
'Count: 0

C#

using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;

public class Demo
{
    public static void Main()
    {
        Collection<string> dinosaurs = new
 Collection<string>();

        dinosaurs.Add("Psitticosaurus");
        dinosaurs.Add("Caudipteryx");
        dinosaurs.Add("Compsognathus");
        dinosaurs.Add("Muttaburrasaurus");

        Console.WriteLine("{0} dinosaurs:", dinosaurs.Count);
        Display(dinosaurs);
    
        Console.WriteLine("\nIndexOf(\"Muttaburrasaurus\"): {0}",
 
            dinosaurs.IndexOf("Muttaburrasaurus"));

        Console.WriteLine("\nContains(\"Caudipteryx\"): {0}",
 
            dinosaurs.Contains("Caudipteryx"));

        Console.WriteLine("\nInsert(2, \"Nanotyrannus\")");
        dinosaurs.Insert(2, "Nanotyrannus");
        Display(dinosaurs);

        Console.WriteLine("\ndinosaurs[2]: {0}", dinosaurs[2]);

        Console.WriteLine("\ndinosaurs[2] = \"Microraptor\"");
        dinosaurs[2] = "Microraptor";
        Display(dinosaurs);

        Console.WriteLine("\nRemove(\"Microraptor\")");
        dinosaurs.Remove("Microraptor");
        Display(dinosaurs);

        Console.WriteLine("\nRemoveAt(0)");
        dinosaurs.RemoveAt(0);
        Display(dinosaurs);

        Console.WriteLine("\ndinosaurs.Clear()");
        dinosaurs.Clear();
        Console.WriteLine("Count: {0}", dinosaurs.Count);
    }
    
    private static void
 Display(Collection<string> cs)
    {
        Console.WriteLine();
        foreach( string item in
 cs )
        {
            Console.WriteLine(item);
        }
    }
}

/* This code example produces the following output:

4 dinosaurs:

Psitticosaurus
Caudipteryx
Compsognathus
Muttaburrasaurus

IndexOf("Muttaburrasaurus"): 3

Contains("Caudipteryx"): True

Insert(2, "Nanotyrannus")

Psitticosaurus
Caudipteryx
Nanotyrannus
Compsognathus
Muttaburrasaurus

dinosaurs[2]: Nanotyrannus

dinosaurs[2] = "Microraptor"

Psitticosaurus
Caudipteryx
Microraptor
Compsognathus
Muttaburrasaurus

Remove("Microraptor")

Psitticosaurus
Caudipteryx
Compsognathus
Muttaburrasaurus

RemoveAt(0)

Caudipteryx
Compsognathus
Muttaburrasaurus

dinosaurs.Clear()
Count: 0
 */

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0
.NET Compact Framework
サポート対象 : 2.0

参照

関連項目
Collection ジェネリック クラス
Collection メンバ
System.Collections.ObjectModel 名前空間
Insert
InsertItem
Remove
RemoveAt
RemoveItem
Count