コレクション (Visual Basic)Collections (Visual Basic)

多くのアプリケーションで、関連するオブジェクトのグループの作成および管理が必要になります。For many applications, you want to create and manage groups of related objects. オブジェクトをグループ化するには、オブジェクトの配列を作成する方法と、オブジェクトのコレクションを作成する方法があります。There are two ways to group objects: by creating arrays of objects, and by creating collections of objects.

配列は、数が固定されている厳密に型指定されたオブジェクトの作成および処理に最も適しています。Arrays are most useful for creating and working with a fixed number of strongly-typed objects. 配列の詳細については、「配列」を参照してください。For information about arrays, see Arrays.

コレクションは、オブジェクトのグループをより柔軟に処理できます。Collections provide a more flexible way to work with groups of objects. 配列の場合とは違って、コレクションで扱うオブジェクトのグループは、アプリケーションの変更に伴う必要に応じて動的に拡大および縮小できます。Unlike arrays, the group of objects you work with can grow and shrink dynamically as the needs of the application change. コレクションによっては、コレクションに含まれるオブジェクトのキーを割り当てると、そのキーを使用してオブジェクトを迅速に取り出すことができます。For some collections, you can assign a key to any object that you put into the collection so that you can quickly retrieve the object by using the key.

コレクションはクラスであるため、そのコレクションに要素を追加するには、事前にそのクラスのインスタンスを宣言する必要があります。A collection is a class, so you must declare an instance of the class before you can add elements to that collection.

含まれる要素が 1 つのデータ型だけのコレクションの場合は、System.Collections.Generic 名前空間のクラスのいずれかを使用できます。If your collection contains elements of only one data type, you can use one of the classes in the System.Collections.Generic namespace. ジェネリック コレクションでは、タイプ セーフが強制されるため、他のデータ型を追加することはできません。A generic collection enforces type safety so that no other data type can be added to it. ジェネリック コレクションから要素を取得する場合は、データ型を判断したり、変換したりする必要はありません。When you retrieve an element from a generic collection, you do not have to determine its data type or convert it.

注意

このトピックの例では、System.Collections.Generic および System.Linq 名前空間のImportsステートメントを含めます。For the examples in this topic, include Imports statements for the System.Collections.Generic and System.Linq namespaces.

単純なコレクションを使用するUsing a Simple Collection

このセクションの例では、厳密に型指定されたオブジェクトの一覧を使用できる、ジェネリックの List<T> クラスを使用します。The examples in this section use the generic List<T> class, which enables you to work with a strongly typed list of objects.

次の例は、文字列のリストを作成し、For Each...Nextステートメントを使用して、文字列を反復処理します。The following example creates a list of strings and then iterates through the strings by using a For Each…Next statement.

' Create a list of strings.
Dim salmons As New List(Of String)
salmons.Add("chinook")
salmons.Add("coho")
salmons.Add("pink")
salmons.Add("sockeye")

' Iterate through the list.
For Each salmon As String In salmons
    Console.Write(salmon & " ")
Next
'Output: chinook coho pink sockeye

コレクションのコンテンツが既知の場合、コレクションの初期化にコレクション初期化子を使用できます。If the contents of a collection are known in advance, you can use a collection initializer to initialize the collection. 詳細については、「コレクション初期化子」を参照してください。For more information, see Collection Initializers.

次の例は、コレクションへの要素の追加にコレクション初期化子を使用する以外、前の例と同じです。The following example is the same as the previous example, except a collection initializer is used to add elements to the collection.

' Create a list of strings by using a
' collection initializer.
Dim salmons As New List(Of String) From
    {"chinook", "coho", "pink", "sockeye"}

For Each salmon As String In salmons
    Console.Write(salmon & " ")
Next
'Output: chinook coho pink sockeye

For Eachステートメントの代わりに、For...Nextステートメントをコレクションの反復処理に使用することができます。You can use a For…Next statement instead of a For Each statement to iterate through a collection. インデックス位置によってコレクションの要素にアクセスすることで、これを実現します。You accomplish this by accessing the collection elements by the index position. 要素のインデックスは、0 から開始し、要素の数から 1 少ない値で終了します。The index of the elements starts at 0 and ends at the element count minus 1.

次の例は、For…Next の代わりに For Each を使用して、コレクションの要素を反復処理します。The following example iterates through the elements of a collection by using For…Next instead of For Each.

Dim salmons As New List(Of String) From
    {"chinook", "coho", "pink", "sockeye"}

For index = 0 To salmons.Count - 1
    Console.Write(salmons(index) & " ")
Next
'Output: chinook coho pink sockeye

次の例は、削除するオブジェクトを指定して、コレクションから要素を削除します。The following example removes an element from the collection by specifying the object to remove.

' Create a list of strings by using a
' collection initializer.
Dim salmons As New List(Of String) From
    {"chinook", "coho", "pink", "sockeye"}

' Remove an element in the list by specifying
' the object.
salmons.Remove("coho")

For Each salmon As String In salmons
    Console.Write(salmon & " ")
Next
'Output: chinook pink sockeye

次の例では、ジェネリック リストからすべての要素を削除します。The following example removes elements from a generic list. For Eachステートメントの代わりに、降順に反復処理するFor...Nextステートメントを使用します。Instead of a For Each statement, a For…Next statement that iterates in descending order is used. これは、RemoveAt メソッドを実行すると、削除された要素の後にある要素のインデックス値が小さくなるためです。This is because the RemoveAt method causes elements after a removed element to have a lower index value.

Dim numbers As New List(Of Integer) From
    {0, 1, 2, 3, 4, 5, 6, 7, 8, 9}

' Remove odd numbers.
For index As Integer = numbers.Count - 1 To 0 Step -1
    If numbers(index) Mod 2 = 1 Then
        ' Remove the element by specifying
        ' the zero-based index in the list.
        numbers.RemoveAt(index)
    End If
Next

' Iterate through the list.
' A lambda expression is placed in the ForEach method
' of the List(T) object.
numbers.ForEach(
    Sub(number) Console.Write(number & " "))
' Output: 0 2 4 6 8

List<T> の要素の型には、独自のクラスも定義できます。For the type of elements in the List<T>, you can also define your own class. 次の例では、List<T> が使用する Galaxy クラスがコードに定義されています。In the following example, the Galaxy class that is used by the List<T> is defined in the code.

Private Sub IterateThroughList()
    Dim theGalaxies As New List(Of Galaxy) From
        {
            New Galaxy With {.Name = "Tadpole", .MegaLightYears = 400},
            New Galaxy With {.Name = "Pinwheel", .MegaLightYears = 25},
            New Galaxy With {.Name = "Milky Way", .MegaLightYears = 0},
            New Galaxy With {.Name = "Andromeda", .MegaLightYears = 3}
        }

    For Each theGalaxy In theGalaxies
        With theGalaxy
            Console.WriteLine(.Name & "  " & .MegaLightYears)
        End With
    Next

    ' Output:
    '  Tadpole  400
    '  Pinwheel  25
    '  Milky Way  0
    '  Andromeda  3
End Sub

Public Class Galaxy
    Public Property Name As String
    Public Property MegaLightYears As Integer
End Class

コレクションの種類Kinds of Collections

.NET Framework は、多くの共通のコレクションを提供します。Many common collections are provided by the .NET Framework. 各コレクションの型は、固有の目的に合わせてデザインされています。Each type of collection is designed for a specific purpose.

このセクションでは、次の共通のコレクション クラスをいつくか説明します:Some of the common collection classes are described in this section:

System.Collections.Generic のクラスSystem.Collections.Generic Classes

System.Collections.Generic 名前空間の 1 つのクラスを使用すると、ジェネリック コレクションを作成できます。You can create a generic collection by using one of the classes in the System.Collections.Generic namespace. ジェネリック コレクションは、コレクション内のすべての項目が同じデータ型である場合に便利です。A generic collection is useful when every item in the collection has the same data type. ジェネリック コレクションには該当するデータ型しか追加できないため、厳密な型指定が適用されます。A generic collection enforces strong typing by allowing only the desired data type to be added.

次のテーブルは System.Collections.Generic 名前空間でよく使用されるクラスの一覧です:The following table lists some of the frequently used classes of the System.Collections.Generic namespace:

クラスClass 説明Description
Dictionary<TKey,TValue> キーに基づいて編成された、キーと値のペアのコレクションを表します。Represents a collection of key/value pairs that are organized based on the key.
List<T> インデックスを使用してアクセスできる、オブジェクトの一覧を表します。Represents a list of objects that can be accessed by index. リストの検索、並べ替え、および変更のメソッドを提供します。Provides methods to search, sort, and modify lists.
Queue<T> 先入れ先出し (FIFO) のオブジェクトのコレクションを表します。Represents a first in, first out (FIFO) collection of objects.
SortedList<TKey,TValue> 関連付けられた IComparer<T> 実装に基づいて、キーにより並べ替えられた、キーと値のペアのコレクションを表します。Represents a collection of key/value pairs that are sorted by key based on the associated IComparer<T> implementation.
Stack<T> 後入れ先出し (LIFO) のオブジェクトのコレクションを表します。Represents a last in, first out (LIFO) collection of objects.

詳細については、「一般的に使用されるコレクション型」、「コレクション クラスの選択」、「System.Collections.Generic」を参照してください。For additional information, see Commonly Used Collection Types, Selecting a Collection Class, and System.Collections.Generic.

System.Collections.Concurrent のクラスSystem.Collections.Concurrent Classes

.NET Framework 4 以降では、System.Collections.Concurrent 名前空間のコレクションによって、複数のスレッドからコレクション項目にアクセスするための効率的なスレッド セーフ操作が可能になります。In the .NET Framework 4 or newer, the collections in the System.Collections.Concurrent namespace provide efficient thread-safe operations for accessing collection items from multiple threads.

System.Collections.Concurrent 名前空間のクラスは、複数のスレッドがコレクションに同時にアクセスするときに、System.Collections.Generic 名前空間および System.Collections 名前空間の対応する型の代わりに使用する必要があります。The classes in the System.Collections.Concurrent namespace should be used instead of the corresponding types in the System.Collections.Generic and System.Collections namespaces whenever multiple threads are accessing the collection concurrently. 詳しくは、「スレッド セーフなコレクション」と「System.Collections.Concurrent」を参照してください。For more information, see Thread-Safe Collections and System.Collections.Concurrent.

System.Collections.Concurrent 名前空間には、BlockingCollection<T>ConcurrentDictionary<TKey,TValue>ConcurrentQueue<T>、および ConcurrentStack<T> などのクラスがあります。Some classes included in the System.Collections.Concurrent namespace are BlockingCollection<T>, ConcurrentDictionary<TKey,TValue>, ConcurrentQueue<T>, and ConcurrentStack<T>.

System.Collections のクラスSystem.Collections Classes

System.Collections 名前空間のクラスでは、要素は、固有の型のオブジェクトとしてではなく Object 型のオブジェクトとして格納されます。The classes in the System.Collections namespace do not store elements as specifically typed objects, but as objects of type Object.

できる限り、System.Collections.Generic 名前空間の従来の型の代わりに、System.Collections.Concurrent 名前空間または System.Collections 名前空間のジェネリック コレクションを使用します。Whenever possible, you should use the generic collections in the System.Collections.Generic namespace or the System.Collections.Concurrent namespace instead of the legacy types in the System.Collections namespace.

次のテーブルは System.Collections 名前空間でよく使用されるクラスの一覧です:The following table lists some of the frequently used classes in the System.Collections namespace:

クラスClass 説明Description
ArrayList 必要に応じてサイズが動的に拡大されるオブジェクトの配列を表します。Represents an array of objects whose size is dynamically increased as required.
Hashtable キーのハッシュ コードに基づいて編成された、キーと値のペアのコレクションを表します。Represents a collection of key/value pairs that are organized based on the hash code of the key.
Queue 先入れ先出し (FIFO) のオブジェクトのコレクションを表します。Represents a first in, first out (FIFO) collection of objects.
Stack 後入れ先出し (LIFO) のオブジェクトのコレクションを表します。Represents a last in, first out (LIFO) collection of objects.

System.Collections.Specialized 名前空間には、文字列専用のコレクションやリンク リスト、ハイブリッド ディクショナリなど、厳密に型指定された専用のコレクション クラスが用意されています。The System.Collections.Specialized namespace provides specialized and strongly typed collection classes, such as string-only collections and linked-list and hybrid dictionaries.

Visual Basic のコレクション クラスVisual Basic Collection Class

数値インデックスまたは String キーを使用したコレクション項目にアクセスするには、Visual Basic の Collection クラスを使用できます。You can use the Visual Basic Collection class to access a collection item by using either a numeric index or a String key. キーを指定してもしなくても、項目をコレクション オブジェクトに追加できます。You can add items to a collection object either with or without specifying a key. キーを使わずに項目を追加した場合は、その項目にアクセスするときに数値インデックスを使う必要があります。If you add an item without a key, you must use its numeric index to access it.

Visual Basic の Collection クラスは、そのすべての要素を Object 型として保存するため、任意のデータ型の項目を追加できます。The Visual Basic Collection class stores all its elements as type Object, so you can add an item of any data type. 不適切なデータ型が追加されないようにする保護機能はありません。There is no safeguard against inappropriate data types being added.

Visual Basic の Collection クラスを使用すると、コレクション内の最初の項目はインデックス 1 となります。When you use the Visual Basic Collection class, the first item in a collection has an index of 1. これは、インデックスが 0 から開始される .NET Framework のコレクション クラスとは異なります。This differs from the .NET Framework collection classes, for which the starting index is 0.

できる限り、Visual Basic の Collection クラスの代わりに、System.Collections.Generic 名前空間または System.Collections.Concurrent 名前空間のジェネリック コレクションを使用してください。Whenever possible, you should use the generic collections in the System.Collections.Generic namespace or the System.Collections.Concurrent namespace instead of the Visual Basic Collection class.

詳細については、「 Collection 」を参照してください。For more information, see Collection.

キーと値のペアのコレクションを実装するImplementing a Collection of Key/Value Pairs

Dictionary<TKey,TValue> ジェネリック コレクションでは、各要素のキーを使用してコレクションの要素にアクセスできます。The Dictionary<TKey,TValue> generic collection enables you to access to elements in a collection by using the key of each element. ディクショナリに追加される各エントリは、値とその値に関連付けられたキーで構成されます。Each addition to the dictionary consists of a value and its associated key. Dictionary クラスはハッシュ テーブルとして実装されているため、キーを使用した値の取得は非常に高速になります。Retrieving a value by using its key is fast because the Dictionary class is implemented as a hash table.

次の例では Dictionary のコレクションを作成し、For Each ステートメントを使用してディクショナリを反復処理します。The following example creates a Dictionary collection and iterates through the dictionary by using a For Each statement.

Private Sub IterateThroughDictionary()
    Dim elements As Dictionary(Of String, Element) = BuildDictionary()

    For Each kvp As KeyValuePair(Of String, Element) In elements
        Dim theElement As Element = kvp.Value

        Console.WriteLine("key: " & kvp.Key)
        With theElement
            Console.WriteLine("values: " & .Symbol & " " &
                .Name & " " & .AtomicNumber)
        End With
    Next
End Sub

Private Function BuildDictionary() As Dictionary(Of String, Element)
    Dim elements As New Dictionary(Of String, Element)

    AddToDictionary(elements, "K", "Potassium", 19)
    AddToDictionary(elements, "Ca", "Calcium", 20)
    AddToDictionary(elements, "Sc", "Scandium", 21)
    AddToDictionary(elements, "Ti", "Titanium", 22)

    Return elements
End Function

Private Sub AddToDictionary(ByVal elements As Dictionary(Of String, Element),
ByVal symbol As String, ByVal name As String, ByVal atomicNumber As Integer)
    Dim theElement As New Element

    theElement.Symbol = symbol
    theElement.Name = name
    theElement.AtomicNumber = atomicNumber

    elements.Add(Key:=theElement.Symbol, value:=theElement)
End Sub

Public Class Element
    Public Property Symbol As String
    Public Property Name As String
    Public Property AtomicNumber As Integer
End Class

コレクション初期化子を使用して Dictionary コレクションをビルドする代わりに、BuildDictionary および AddToDictionary メソッドを次のメソッドに置換できます。To instead use a collection initializer to build the Dictionary collection, you can replace the BuildDictionary and AddToDictionary methods with the following method.

Private Function BuildDictionary2() As Dictionary(Of String, Element)
    Return New Dictionary(Of String, Element) From
        {
            {"K", New Element With
                {.Symbol = "K", .Name = "Potassium", .AtomicNumber = 19}},
            {"Ca", New Element With
                {.Symbol = "Ca", .Name = "Calcium", .AtomicNumber = 20}},
            {"Sc", New Element With
                {.Symbol = "Sc", .Name = "Scandium", .AtomicNumber = 21}},
            {"Ti", New Element With
                {.Symbol = "Ti", .Name = "Titanium", .AtomicNumber = 22}}
        }
End Function

次の例では、キーによって項目をすばやく検索するために、ContainsKeyItem[TKey] メソッドと Dictionary プロパティを使用します。The following example uses the ContainsKey method and the Item[TKey] property of Dictionary to quickly find an item by key. Item プロパティを使用すると、Visual Basic の elements(symbol) コードを使用して、elements コレクション内の項目にアクセスできます。The Item property enables you to access an item in the elements collection by using the elements(symbol) code in Visual Basic.

Private Sub FindInDictionary(ByVal symbol As String)
    Dim elements As Dictionary(Of String, Element) = BuildDictionary()

    If elements.ContainsKey(symbol) = False Then
        Console.WriteLine(symbol & " not found")
    Else
        Dim theElement = elements(symbol)
        Console.WriteLine("found: " & theElement.Name)
    End If
End Sub

次の例では、キーによって項目をすばやく検索するために、TryGetValue メソッドを代わりに使用します。The following example instead uses the TryGetValue method quickly find an item by key.

Private Sub FindInDictionary2(ByVal symbol As String)
    Dim elements As Dictionary(Of String, Element) = BuildDictionary()

    Dim theElement As Element = Nothing
    If elements.TryGetValue(symbol, theElement) = False Then
        Console.WriteLine(symbol & " not found")
    Else
        Console.WriteLine("found: " & theElement.Name)
    End If
End Sub

LINQ を使用してコレクションにアクセスするUsing LINQ to Access a Collection

統合言語クエリ (LINQ) を使用してコレクションにアクセスできます。LINQ (Language-Integrated Query) can be used to access collections. LINQ クエリは、フィルター処理、並べ替え、およびグループ化の機能を提供します。LINQ queries provide filtering, ordering, and grouping capabilities. 詳細については、「 Visual Basic での LINQ のはじめに」を参照してください。For more information, see Getting Started with LINQ in Visual Basic.

次の例では、ジェネリック List に対して LINQ クエリを実行します。The following example runs a LINQ query against a generic List. LINQ クエリは、結果が格納されている別のコレクションを戻します。The LINQ query returns a different collection that contains the results.

Private Sub ShowLINQ()
    Dim elements As List(Of Element) = BuildList()

    ' LINQ Query.
    Dim subset = From theElement In elements
                  Where theElement.AtomicNumber < 22
                  Order By theElement.Name

    For Each theElement In subset
        Console.WriteLine(theElement.Name & " " & theElement.AtomicNumber)
    Next

    ' Output:
    '  Calcium 20
    '  Potassium 19
    '  Scandium 21
End Sub

Private Function BuildList() As List(Of Element)
    Return New List(Of Element) From
        {
            {New Element With
                {.Symbol = "K", .Name = "Potassium", .AtomicNumber = 19}},
            {New Element With
                {.Symbol = "Ca", .Name = "Calcium", .AtomicNumber = 20}},
            {New Element With
                {.Symbol = "Sc", .Name = "Scandium", .AtomicNumber = 21}},
            {New Element With
                {.Symbol = "Ti", .Name = "Titanium", .AtomicNumber = 22}}
        }
End Function

Public Class Element
    Public Property Symbol As String
    Public Property Name As String
    Public Property AtomicNumber As Integer
End Class

コレクションを並べ替えるSorting a Collection

次の例では、コレクションを並べ替えるための手順を示しています。The following example illustrates a procedure for sorting a collection. この例は、Car に格納されている List<T> クラスのインスタンスの並べ替えを実行します。The example sorts instances of the Car class that are stored in a List<T>. Car クラスは、IComparable<T> のメソッドの実装を必要とする CompareTo インターフェイスを実装します。The Car class implements the IComparable<T> interface, which requires that the CompareTo method be implemented.

CompareTo メソッドに対する各呼び出しは、並べ替えに使用される単一の比較を実行します。Each call to the CompareTo method makes a single comparison that is used for sorting. CompareTo メソッドのユーザーが作成したコードは、現在のオブジェクトと別のオブジェクトとの各比較の値を戻します。User-written code in the CompareTo method returns a value for each comparison of the current object with another object. 現在のオブジェクトが別のオブジェクトよりも小さい場合はゼロ未満の値を、大きい場合はゼロ以上の値を、等しい場合はゼロを戻します。The value returned is less than zero if the current object is less than the other object, greater than zero if the current object is greater than the other object, and zero if they are equal. これによって、より大きい、より小さい、等しい、の条件をコードに定義することができます。This enables you to define in code the criteria for greater than, less than, and equal.

ListCars のメソッドでは、cars.Sort() ステートメントがリストを並べ替えます。In the ListCars method, the cars.Sort() statement sorts the list. SortList<T> メソッドへの呼び出しによって、CompareTo メソッドは Car 内の List オブジェクトに自動的に呼び出されます。This call to the Sort method of the List<T> causes the CompareTo method to be called automatically for the Car objects in the List.

Public Sub ListCars()

    ' Create some new cars.
    Dim cars As New List(Of Car) From
    {
        New Car With {.Name = "car1", .Color = "blue", .Speed = 20},
        New Car With {.Name = "car2", .Color = "red", .Speed = 50},
        New Car With {.Name = "car3", .Color = "green", .Speed = 10},
        New Car With {.Name = "car4", .Color = "blue", .Speed = 50},
        New Car With {.Name = "car5", .Color = "blue", .Speed = 30},
        New Car With {.Name = "car6", .Color = "red", .Speed = 60},
        New Car With {.Name = "car7", .Color = "green", .Speed = 50}
    }

    ' Sort the cars by color alphabetically, and then by speed
    ' in descending order.
    cars.Sort()

    ' View all of the cars.
    For Each thisCar As Car In cars
        Console.Write(thisCar.Color.PadRight(5) & " ")
        Console.Write(thisCar.Speed.ToString & " ")
        Console.Write(thisCar.Name)
        Console.WriteLine()
    Next

    ' Output:
    '  blue  50 car4
    '  blue  30 car5
    '  blue  20 car1
    '  green 50 car7
    '  green 10 car3
    '  red   60 car6
    '  red   50 car2
End Sub

Public Class Car
    Implements IComparable(Of Car)

    Public Property Name As String
    Public Property Speed As Integer
    Public Property Color As String

    Public Function CompareTo(ByVal other As Car) As Integer _
        Implements System.IComparable(Of Car).CompareTo
        ' A call to this method makes a single comparison that is
        ' used for sorting.

        ' Determine the relative order of the objects being compared.
        ' Sort by color alphabetically, and then by speed in
        ' descending order.

        ' Compare the colors.
        Dim compare As Integer
        compare = String.Compare(Me.Color, other.Color, True)

        ' If the colors are the same, compare the speeds.
        If compare = 0 Then
            compare = Me.Speed.CompareTo(other.Speed)

            ' Use descending order for speed.
            compare = -compare
        End If

        Return compare
    End Function
End Class

カスタム コレクションを定義するDefining a Custom Collection

IEnumerable<T> または IEnumerable のインターフェイスを実装してコレクションを定義できます。You can define a collection by implementing the IEnumerable<T> or IEnumerable interface. 詳細については、「コレクションの列挙」を参照してください。For additional information, see Enumerating a Collection.

カスタム コレクションを定義できますが、通常は、.NET Framework に含まれるコレクションを使用することが推奨されます。これについては、このトピックのコレクションの種類で既に説明されています。Although you can define a custom collection, it is usually better to instead use the collections that are included in the .NET Framework, which are described in Kinds of Collections earlier in this topic.

次の例は、AllColors という名前のカスタム コレクション クラスを定義します。The following example defines a custom collection class named AllColors. このクラスは、IEnumerable メソッドの実装を必要とする GetEnumerator インターフェイスを実装します。This class implements the IEnumerable interface, which requires that the GetEnumerator method be implemented.

GetEnumerator メソッドは、ColorEnumerator クラスのインスタンスを戻します。The GetEnumerator method returns an instance of the ColorEnumerator class. ColorEnumerator は、IEnumerator プロパティ、Current メソッド、および MoveNext メソッドの実装を必要とする Reset インターフェイスを実装します。ColorEnumerator implements the IEnumerator interface, which requires that the Current property, MoveNext method, and Reset method be implemented.

Public Sub ListColors()
    Dim colors As New AllColors()

    For Each theColor As Color In colors
        Console.Write(theColor.Name & " ")
    Next
    Console.WriteLine()
    ' Output: red blue green
End Sub

' Collection class.
Public Class AllColors
    Implements System.Collections.IEnumerable

    Private _colors() As Color =
    {
        New Color With {.Name = "red"},
        New Color With {.Name = "blue"},
        New Color With {.Name = "green"}
    }

    Public Function GetEnumerator() As System.Collections.IEnumerator _
        Implements System.Collections.IEnumerable.GetEnumerator

        Return New ColorEnumerator(_colors)

        ' Instead of creating a custom enumerator, you could
        ' use the GetEnumerator of the array.
        'Return _colors.GetEnumerator
    End Function

    ' Custom enumerator.
    Private Class ColorEnumerator
        Implements System.Collections.IEnumerator

        Private _colors() As Color
        Private _position As Integer = -1

        Public Sub New(ByVal colors() As Color)
            _colors = colors
        End Sub

        Public ReadOnly Property Current() As Object _
            Implements System.Collections.IEnumerator.Current
            Get
                Return _colors(_position)
            End Get
        End Property

        Public Function MoveNext() As Boolean _
            Implements System.Collections.IEnumerator.MoveNext
            _position += 1
            Return (_position < _colors.Length)
        End Function

        Public Sub Reset() Implements System.Collections.IEnumerator.Reset
            _position = -1
        End Sub
    End Class
End Class

' Element class.
Public Class Color
    Public Property Name As String
End Class

IteratorsIterators

反復子は、コレクションに対するカスタム イテレーションを実行するために使用されます。An iterator is used to perform a custom iteration over a collection. 反復子は、メソッドまたは get アクセサーのいずれかです。An iterator can be a method or a get accessor. 反復子はYieldステートメントを使用して、コレクションの各要素を一度に 1 つずつ返します。An iterator uses a Yield statement to return each element of the collection one at a time.

For Each...Nextステートメントを使用して、反復子を呼び出します。You call an iterator by using a For Each…Next statement. For Each ループの繰り返しごとに、反復子を呼び出します。Each iteration of the For Each loop calls the iterator. 反復子がYield ステートメントに到達すると、式が返され、コードの現在の位置が保持されます。When a Yield statement is reached in the iterator, an expression is returned, and the current location in code is retained. 次回、反復子が呼び出されると、この位置から実行が再開されます。Execution is restarted from that location the next time that the iterator is called.

詳細については、反復子 (Visual Basic)を参照してください。For more information, see Iterators (Visual Basic).

次の例は、反復子メソッドを使用します。The following example uses an iterator method. 反復子メソッドは、For...Nextループ内にYieldステートメントを持ちます。The iterator method has a Yield statement that is inside a For…Next loop. ListEvenNumbers メソッドでは、For Each ステートメント本体の繰り返しごとに、反復子メソッドの呼び出しを作成し、次の Yield ステートメントに進みます。In the ListEvenNumbers method, each iteration of the For Each statement body creates a call to the iterator method, which proceeds to the next Yield statement.

Public Sub ListEvenNumbers()
    For Each number As Integer In EvenSequence(5, 18)
        Console.Write(number & " ")
    Next
    Console.WriteLine()
    ' Output: 6 8 10 12 14 16 18
End Sub

Private Iterator Function EvenSequence(
ByVal firstNumber As Integer, ByVal lastNumber As Integer) _
As IEnumerable(Of Integer)

' Yield even numbers in the range.
    For number = firstNumber To lastNumber
        If number Mod 2 = 0 Then
            Yield number
        End If
    Next
End Function

関連項目See also