Cet article a fait l’objet d’une traduction automatique. Pour afficher l’article en anglais, activez la case d’option Anglais. Vous pouvez également afficher le texte anglais dans une fenêtre contextuelle en faisant glisser le pointeur de la souris sur le texte traduit.
Traduction
Anglais

IEnumerator interface

 

Date de publication : novembre 2016

Prend en charge une itération simple sur une collection non générique.

Espace de noms:   System.Collections
Assembly:  mscorlib (dans mscorlib.dll)

[GuidAttribute("496B0ABF-CDEE-11d3-88E8-00902754C43A")]
[ComVisibleAttribute(true)]
public interface IEnumerator

NomDescription
System_CAPS_pubpropertyCurrent

Obtient l’élément de la collection situé à la position actuelle de l’énumérateur.

NomDescription
System_CAPS_pubmethodMoveNext()

Avance l’énumérateur à l’élément suivant de la collection.

System_CAPS_pubmethodReset()

Rétablit l’énumérateur à sa position initiale, qui précède le premier élément de la collection.

IEnumeratorest l’interface de base pour tous les énumérateurs non génériques.

Pour la version générique de cette interface, consultez IEnumerator<T>.

L'instruction foreach du langage C# (for each en Visual Basic) se charge de la complexité des énumérateurs. Par conséquent, à l’aide de foreach est recommandé plutôt que de manipuler l’énumérateur directement.

Les énumérateurs peuvent être utilisés pour lire les données de la collection, mais ils ne permettent pas de modifier la collection sous-jacente.

Le Reset méthode est fournie pour l’interopérabilité COM et ne devez pas totalement implémentées ; au lieu de cela, l’implémenteur peut lever un NotSupportedException.

Au départ, l'énumérateur est positionné avant le premier élément de la collection. Vous devez appeler la MoveNext méthode pour avancer l’énumérateur jusqu’au premier élément de la collection avant de lire la valeur de Current; sinon, Current n’est pas défini.

Current retourne le même objet tant que MoveNext ou Reset n'est pas appelé. MoveNext affecte l'élément suivant à Current.

Si MoveNext dépasse la fin de la collection, l’énumérateur est placée après le dernier élément dans la collection et MoveNext retourne false. Lorsque l’énumérateur est à cette position, les appels suivants à MoveNext également retourner false. Si le dernier appel à MoveNext retourné false, l’appel Current lève une exception.

Pour définir Current au premier élément de la collection, vous pouvez appeler Reset, si elle est implémentée, suivi par MoveNext. Si Reset est ne pas implémentée, vous devez créer une nouvelle instance de l’énumérateur pour retourner au premier élément de la collection.

Un énumérateur est valide tant que la collection demeure inchangée. Si des modifications sont apportées à la collection, telles que l’ajout, modification, ou la suppression d’éléments, l’énumérateur est définitivement invalidé et l’appel suivant à MoveNext ou Reset lève une InvalidOperationException. Si la collection est modifiée entre MoveNext et Current, Current retourne l’élément auquel il est attribué, même si l’énumérateur est déjà invalidé.

Comme l'énumérateur ne dispose pas d'un accès exclusif à la collection, l'énumération d'une collection n'est pas intrinsèquement une procédure thread-safe. Même lorsqu'une collection est synchronisée, les autres threads peuvent toujours la modifier, ce qui entraîne la levée d'une exception par l'énumérateur. Pour garantir la sécurité des threads au cours de l'énumération, vous pouvez verrouiller la collection pendant l'ensemble de l'énumération ou bien intercepter les exceptions résultant des modifications apportées par les autres threads.

L’exemple de code suivant montre l’implémentation de la IEnumerable et IEnumerator interfaces pour une collection personnalisée. Dans cet exemple, les membres de ces interfaces ne sont pas appelés explicitement, mais ils sont implémentés pour prendre en charge l’utilisation de foreach (for each en Visual Basic) pour effectuer une itération au sein de la collection.

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
 *
 */

Plateforme Windows universelle
Disponible depuis 8
.NET Framework
Disponible depuis 1.1
Bibliothèque de classes portable
Pris en charge dans : plateformes .NET portables
Silverlight
Disponible depuis 2.0
Silverlight pour Windows Phone
Disponible depuis 7.0
Windows Phone
Disponible depuis 8.1
Retour au début
Afficher: