Коллекции (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.

Если коллекция содержит элементы только одного типа данных, можно использовать один из классов в пространстве имен 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.LinqFor 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.

Следующий пример создает список строк, а затем итерирует через строки с помощью для каждого ... Следующее заявление.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... Следующее заявление For Each вместо оператора для итерата через коллекцию.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 заявления, для ... Используется следующее утверждение, итерирующее в порядке убывания.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. В приведенном ниже примере класс Galaxy, который используется объектом List<T>, определен в коде.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.GenericSystem.Collections.Generic Classes

Универсальную коллекцию можно создать, используя один из классов в пространстве имен System.Collections.Generic.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:

ClassClass Описание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.ConcurrentSystem.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.CollectionsSystem.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:

ClassClass Описание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.

Класс Collection в Visual BasicVisual Basic Collection Class

Класс Collection в Visual Basic можно использовать для доступа к элементу коллекции по числовому индексу или ключу String.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.

Класс Collection в Visual Basic хранит все свои элементы как тип 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.

При использовании класса Collection в Visual Basic первый элемент в коллекции имеет индекс 1.When you use the Visual Basic Collection class, the first item in a collection has an index of 1. Этим он отличается от классов коллекций платформы .NET Framework, для которых начальный индекс равен 0.This differs from the .NET Framework collection classes, for which the starting index is 0.

Везде, где это возможно, следует использовать универсальные коллекции в пространстве имен System.Collections.Generic или пространстве имен System.Collections.Concurrent вместо класса Collection в Visual Basic.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

В приведенном ниже примере используется метод ContainsKey и свойство Item[TKey]Dictionary для быстрого поиска элемента по ключу.The following example uses the ContainsKey method and the Item[TKey] property of Dictionary to quickly find an item by key. Свойство Item позволяет получить доступ к elements элементу elements(symbol) в коллекции, используя код в Visual Basic.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. Для получения дополнительной информации, см. Начало работы с LIN's в Visual Basic.For more information, see Getting Started with LINQ in Visual Basic.

В приведенном ниже примере выполняется запрос LINQ применительно к универсальной коллекции List.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. Итератор использует выписку о доходности, чтобы вернуть каждый элемент коллекции по одному.An iterator uses a Yield statement to return each element of the collection one at a time.

Вы называете итератор с помощью для каждого ... Следующее заявление.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.

Для получения дополнительной информации см.For more information, see Iterators (Visual Basic).

В приведенном ниже примере используется метод-итератор.The following example uses an iterator method. Метод итератора имеет Yield заявление, которое находится внутри For... Следующий цикл.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