IEnumerable 介面

定義

public interface class IEnumerable

public interface IEnumerable

[System.Runtime.InteropServices.Guid("496B0ABE-CDEE-11d3-88E8-00902754C43A")]
public interface IEnumerable

[System.Runtime.InteropServices.Guid("496B0ABE-CDEE-11d3-88E8-00902754C43A")]
[System.Runtime.InteropServices.ComVisible(true)]
public interface IEnumerable

type IEnumerable = interface

[<System.Runtime.InteropServices.Guid("496B0ABE-CDEE-11d3-88E8-00902754C43A")>]
type IEnumerable = interface

[<System.Runtime.InteropServices.Guid("496B0ABE-CDEE-11d3-88E8-00902754C43A")>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type IEnumerable = interface

Public Interface IEnumerable

衍生

Microsoft.Build.BuildEngine.BuildItemGroup

Microsoft.Build.BuildEngine.BuildItemGroupCollection

Microsoft.Build.BuildEngine.BuildPropertyGroup

Microsoft.Build.BuildEngine.BuildPropertyGroupCollection

Microsoft.Build.BuildEngine.ImportCollection

更多…

屬性

GuidAttribute ComVisibleAttribute

範例

下列程式碼範例將示範如何藉由執行和介面，來逐一查看自訂集合的最佳作法 IEnumerable IEnumerator 。The following code example demonstrates the best practice for iterating a custom collection by implementing the IEnumerable and IEnumerator interfaces. 在此範例中，不會明確呼叫這些介面的成員，但會實作為支援使用 foreach For Each Visual Basic) 中的 (，以逐一查看集合。In this example, members of these interfaces are not explicitly called, but they are implemented to support the use of foreach (For Each in Visual Basic) to iterate through the collection. 此範例是完整的主控台應用程式。This example is a complete Console app. 若要編譯 Visual Basic 應用程式，請在專案的 [屬性] 頁面中，將 啟始物件 變更為 Sub Main 。To compile the Visual Basic app, change the Startup object to Sub Main in the project's Properties page.

如需示範如何實行介面的範例 IEnumerable ，請參閱在集合類別中執行 IEnumerable 介面。For a sample that shows how to implement the IEnumerable interface, see Implementing the IEnumerable Interface in a Collection Class

using System;
using System.Collections;

// Simple business object.
public class Person
{
    public Person(string fName, string lName)
    {
        this.firstName = fName;
        this.lastName = lName;
    }

    public string firstName;
    public string lastName;
}

// Collection of Person objects. This class
// implements IEnumerable so that it can be used
// with ForEach syntax.
public class People : IEnumerable
{
    private Person[] _people;
    public People(Person[] pArray)
    {
        _people = new Person[pArray.Length];

        for (int i = 0; i < pArray.Length; i++)
        {
            _people[i] = pArray[i];
        }
    }

// Implementation for the GetEnumerator method.
    IEnumerator IEnumerable.GetEnumerator()
    {
       return (IEnumerator) GetEnumerator();
    }

    public PeopleEnum GetEnumerator()
    {
        return new PeopleEnum(_people);
    }
}

// When you implement IEnumerable, you must also implement IEnumerator.
public class PeopleEnum : IEnumerator
{
    public Person[] _people;

    // Enumerators are positioned before the first element
    // until the first MoveNext() call.
    int position = -1;

    public PeopleEnum(Person[] list)
    {
        _people = list;
    }

    public bool MoveNext()
    {
        position++;
        return (position < _people.Length);
    }

    public void Reset()
    {
        position = -1;
    }

    object IEnumerator.Current
    {
        get
        {
            return Current;
        }
    }

    public Person Current
    {
        get
        {
            try
            {
                return _people[position];
            }
            catch (IndexOutOfRangeException)
            {
                throw new InvalidOperationException();
            }
        }
    }
}

class App
{
    static void Main()
    {
        Person[] peopleArray = new Person[3]
        {
            new Person("John", "Smith"),
            new Person("Jim", "Johnson"),
            new Person("Sue", "Rabon"),
        };

        People peopleList = new People(peopleArray);
        foreach (Person p in peopleList)
            Console.WriteLine(p.firstName + " " + p.lastName);
    }
}

/* This code produces output similar to the following:
 *
 * John Smith
 * Jim Johnson
 * Sue Rabon
 *
 */

Imports System.Collections

' Simple business object.
Public Class Person

    Public Sub New(ByVal fName As String, ByVal lName As String)
        Me.firstName = fName
        Me.lastName = lName
    End Sub


    Public firstName As String
    Public lastName As String
End Class

' Collection of Person objects, which implements IEnumerable so that
' it can be used with ForEach syntax.
Public Class People
    Implements IEnumerable

    Private _people() As Person

    Public Sub New(ByVal pArray() As Person)
        _people = New Person(pArray.Length - 1) {}

        Dim i As Integer
        For i = 0 To pArray.Length - 1
            _people(i) = pArray(i)
        Next i
    End Sub

    ' Implementation of GetEnumerator.
    Public Function GetEnumerator() As IEnumerator _
      Implements IEnumerable.GetEnumerator

        Return New PeopleEnum(_people)
    End Function

End Class

' When you implement IEnumerable, you must also implement IEnumerator.
Public Class PeopleEnum
    Implements IEnumerator

    Public _people() As Person

    ' Enumerators are positioned before the first element
    ' until the first MoveNext() call.
    Dim position As Integer = -1

    Public Sub New(ByVal list() As Person)
        _people = list
    End Sub

    Public Function MoveNext() As Boolean Implements IEnumerator.MoveNext
        position = position + 1
        Return (position < _people.Length)
    End Function

    Public Sub Reset() Implements IEnumerator.Reset
        position = -1
    End Sub

    Public ReadOnly Property Current() As Object Implements IEnumerator.Current
        Get
            Try
                Return _people(position)
            Catch ex As IndexOutOfRangeException
                Throw New InvalidOperationException()
            End Try
        End Get
    End Property
End Class

Class App
    Shared Sub Main()
        Dim peopleArray() As Person = { _
            New Person("John", "Smith"), _
            New Person("Jim", "Johnson"), _
            New Person("Sue", "Rabon")}

        Dim peopleList As New People(peopleArray)
        Dim p As Person
        For Each p In peopleList
            Console.WriteLine(p.firstName + " " + p.lastName)
        Next

    End Sub
End Class

' This code produces output similar to the following:
' 
' John Smith
' Jim Johnson
' Sue Rabon

備註

IEnumerable 是所有可列舉之非泛型集合的基底介面。IEnumerable is the base interface for all non-generic collections that can be enumerated. 如需此介面的泛型版本，請參閱 System.Collections.Generic.IEnumerable<T> 。For the generic version of this interface see System.Collections.Generic.IEnumerable<T>. IEnumerable 包含單一方法，這個方法會傳回 GetEnumerator IEnumerator 。IEnumerable contains a single method, GetEnumerator, which returns an IEnumerator. IEnumerator 提供可透過公開 Current 屬性和和方法來逐一查看集合的 MoveNext 功能 Reset 。IEnumerator provides the ability to iterate through the collection by exposing a Current property and MoveNext and Reset methods.

最佳做法是在 IEnumerable IEnumerator 您的集合類別上執行和，以 foreach For Each 在 Visual Basic) 語法中啟用 (，但 IEnumerable 不需要執行。It is a best practice to implement IEnumerable and IEnumerator on your collection classes to enable the foreach (For Each in Visual Basic) syntax, however implementing IEnumerable is not required. 如果您的集合未執行 IEnumerable ，您仍然必須遵循 iterator 模式來支援此語法，方法是提供傳回 GetEnumerator 介面、類別或結構的方法。If your collection does not implement IEnumerable, you must still follow the iterator pattern to support this syntax by providing a GetEnumerator method that returns an interface, class or struct. 使用 Visual Basic 時，您必須提供 IEnumerator 由傳回的實作為 GetEnumerator 。When using Visual Basic, you must provide an IEnumerator implementation, which is returned by GetEnumerator. 使用 c # 進行開發時，您必須提供包含屬性的類別 Current 和 MoveNext 和的 Reset 方法（如所述 IEnumerator ），但類別不需要執行 IEnumerator 。When developing with C# you must provide a class that contains a Current property, and MoveNext and Reset methods as described by IEnumerator, but the class does not have to implement IEnumerator.

方法

擴充方法

適用於

另請參閱

• IEnumerator
• IEnumerable<T>
• 迭代器 (C#)Iterators (C#)
• 迭代器 (Visual Basic)Iterators (Visual Basic)
• 在集合類別中執行 IEnumerable 介面Implementing the IEnumerable Interface in a Collection Class