IEnumerable インターフェイス

定義

非ジェネリック コレクションに対する単純な反復処理をサポートする列挙子を公開します。Exposes an enumerator, which supports a simple iteration over a non-generic collection.

public interface class IEnumerable
[System.Runtime.InteropServices.ComVisible(true)]
[System.Runtime.InteropServices.Guid("496B0ABE-CDEE-11d3-88E8-00902754C43A")]
public interface IEnumerable
type IEnumerable = interface
Public Interface IEnumerable
派生
属性

次のコード例は、IEnumerableIEnumerator インターフェイスを実装することによってカスタムコレクションを反復処理するためのベストプラクティスを示しています。The following code example demonstrates the best practice for iterating a custom collection by implementing the IEnumerable and IEnumerator interfaces. この例では、これらのインターフェイスのメンバーは明示的に呼び出されませんが、コレクションを反復処理するために foreach (Visual Basic でFor Each) の使用をサポートするように実装されています。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 アプリをコンパイルするには、プロジェクトのプロパティページでStartup オブジェクト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 には、IEnumeratorを返す1つのメソッド GetEnumeratorが含まれています。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.

foreach (For Each Visual Basic) 構文を有効にするには、IEnumerable を実装し、コレクションクラスに IEnumerator を実装することをお勧めします。ただし、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が実装されていない場合でも、インターフェイス、クラス、または構造体を返す 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 プロパティを含むクラスを指定する必要があります。また、IEnumeratorで説明されているようにメソッドを MoveNext および Reset しますが、クラスで 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.

メソッド

GetEnumerator()

コレクションを繰り返し処理する列挙子を返します。Returns an enumerator that iterates through a collection.

拡張メソッド

Cast<TResult>(IEnumerable)

IEnumerable の要素を、指定した型にキャストします。Casts the elements of an IEnumerable to the specified type.

OfType<TResult>(IEnumerable)

指定された型に基づいて IEnumerable の要素をフィルター処理します。Filters the elements of an IEnumerable based on a specified type.

AsParallel(IEnumerable)

クエリの並列化を有効にします。Enables parallelization of a query.

AsQueryable(IEnumerable)

IEnumerableIQueryable に変換します。Converts an IEnumerable to an IQueryable.

適用対象

こちらもご覧ください