Share via


CollectionAssert.Contains Method (ICollection, Object, String, array<Object )

Verifies that the specified collection contains the specified element. The assertion fails if the element is not found in the collection. Displays a message if the assertion fails, and applies the specified formatting to it.

Namespace:  Microsoft.VisualStudio.TestTools.UnitTesting
Assembly:  Microsoft.VisualStudio.QualityTools.UnitTestFramework (in Microsoft.VisualStudio.QualityTools.UnitTestFramework.dll)

Syntax

'Declaration
Public Shared Sub Contains ( _
    collection As ICollection, _
    element As Object, _
    message As String, _
    ParamArray parameters As Object() _
)
public static void Contains(
    ICollection collection,
    Object element,
    string message,
    params Object[] parameters
)
public:
static void Contains(
    ICollection^ collection, 
    Object^ element, 
    String^ message, 
    ... array<Object^>^ parameters
)
static member Contains : 
        collection:ICollection * 
        element:Object * 
        message:string * 
        parameters:Object[] -> unit
public static function Contains(
    collection : ICollection, 
    element : Object, 
    message : String, 
    ... parameters : Object[]
)

Parameters

  • collection
    Type: ICollection

    The collection in which to search for the element.

  • element
    Type: Object

    The element that is expected to be in the collection.

  • message
    Type: String

    A message to display if the assertion fails. This message can be seen in the unit test results.

  • parameters
    Type: array<Object[]

    An array of parameters to use when formatting message.

Exceptions

Exception Condition
AssertFailedException

element is not found in collection.

.NET Framework Security

See Also

Reference

CollectionAssert Class

Contains Overload

Microsoft.VisualStudio.TestTools.UnitTesting Namespace

Other Resources

Using the Assert Classes