Enumerable.Contains Méthode

Définition

Espace de noms:

System.Linq

Assembly:

System.Linq.dll

Détermine si une séquence contient un élément spécifié.

Surcharges

Contains<TSource>(IEnumerable<TSource>, TSource)	Détermine si une séquence contient un élément spécifié à l'aide du comparateur d'égalité par défaut.
Contains<TSource>(IEnumerable<TSource>, TSource, IEqualityComparer<TSource>)	Détermine si une séquence contient un élément spécifié à l'aide du IEqualityComparer<T> indiqué.

Contains<TSource>(IEnumerable<TSource>, TSource)

Source:

Contains.cs

Détermine si une séquence contient un élément spécifié à l'aide du comparateur d'égalité par défaut.

C#

public static bool Contains<TSource> (this System.Collections.Generic.IEnumerable<TSource> source, TSource value);

Paramètres de type

TSource

Le type des éléments de source.

Paramètres

source

IEnumerable<TSource>

Séquence dans laquelle localiser une valeur.

value

TSource

Valeur à localiser dans la séquence.

Retours

Boolean

true si la séquence source contient un élément avec la valeur spécifiée ; sinon, false.

Exceptions

ArgumentNullException

source a la valeur null.

Exemples

L’exemple de code suivant montre comment utiliser Contains<TSource>(IEnumerable<TSource>, TSource) pour déterminer si un tableau contient un élément spécifique.

C#

string[] fruits = { "apple", "banana", "mango", "orange", "passionfruit", "grape" };

string fruit = "mango";

bool hasMango = fruits.Contains(fruit);

Console.WriteLine(
    "The array {0} contain '{1}'.",
    hasMango ? "does" : "does not",
    fruit);

// This code produces the following output:
//
// The array does contain 'mango'.

Remarques

Si le type d’implémente sourceICollection<T>, la Contains méthode dans cette implémentation est appelée pour obtenir le résultat. Sinon, cette méthode détermine si source contient l’élément spécifié.

L’énumération est terminée dès qu’un élément correspondant est trouvé.

Les éléments sont comparés à la valeur spécifiée à l’aide du comparateur d’égalité par défaut, Default.

Contains<TSource>(IEnumerable<TSource>, TSource, IEqualityComparer<TSource>)

Source:

Contains.cs

Détermine si une séquence contient un élément spécifié à l'aide du IEqualityComparer<T> indiqué.

C#

public static bool Contains<TSource> (this System.Collections.Generic.IEnumerable<TSource> source, TSource value, System.Collections.Generic.IEqualityComparer<TSource>? comparer);

Paramètres de type

TSource

Le type des éléments de source.

Paramètres

source

IEnumerable<TSource>

Séquence dans laquelle localiser une valeur.

value

TSource

Valeur à localiser dans la séquence.

comparer

IEqualityComparer<TSource>

Comparateur d'égalité à l'aide duquel comparer des valeurs.

Retours

Boolean

true si la séquence source contient un élément avec la valeur spécifiée ; sinon, false.

Exceptions

ArgumentNullException

source a la valeur null.

Exemples

L’exemple suivant montre comment implémenter un comparateur d’égalité qui peut être utilisé dans la Contains méthode .

C#

public class Product
{
    public string Name { get; set; }
    public int Code { get; set; }
}

// Custom comparer for the Product class
class ProductComparer : IEqualityComparer<Product>
{
    // Products are equal if their names and product numbers are equal.
    public bool Equals(Product x, Product y)
    {

        //Check whether the compared objects reference the same data.
        if (Object.ReferenceEquals(x, y)) return true;

        //Check whether any of the compared objects is null.
        if (Object.ReferenceEquals(x, null) || Object.ReferenceEquals(y, null))
            return false;

        //Check whether the products' properties are equal.
        return x.Code == y.Code && x.Name == y.Name;
    }

    // If Equals() returns true for a pair of objects
    // then GetHashCode() must return the same value for these objects.

    public int GetHashCode(Product product)
    {
        //Check whether the object is null
        if (Object.ReferenceEquals(product, null)) return 0;

        //Get hash code for the Name field if it is not null.
        int hashProductName = product.Name == null ? 0 : product.Name.GetHashCode();

        //Get hash code for the Code field.
        int hashProductCode = product.Code.GetHashCode();

        //Calculate the hash code for the product.
        return hashProductName ^ hashProductCode;
    }
}

Après avoir implémenté ce comparateur, vous pouvez utiliser une séquence d’objets Product dans la Contains méthode, comme illustré dans l’exemple suivant :

C#

Product[] fruits = { new Product { Name = "apple", Code = 9 },
                       new Product { Name = "orange", Code = 4 },
                       new Product { Name = "lemon", Code = 12 } };

Product apple = new Product { Name = "apple", Code = 9 };
Product kiwi = new Product { Name = "kiwi", Code = 8 };

ProductComparer prodc = new ProductComparer();

bool hasApple = fruits.Contains(apple, prodc);
bool hasKiwi = fruits.Contains(kiwi, prodc);

Console.WriteLine("Apple? " + hasApple);
Console.WriteLine("Kiwi? " + hasKiwi);

/*
    This code produces the following output:

    Apple? True
    Kiwi? False
*/

Remarques

L’énumération est terminée dès qu’un élément correspondant est trouvé.

Si comparer est null, le comparateur d’égalité par défaut, Default, est utilisé pour comparer les éléments à la valeur spécifiée.