Xceed Logo
Shop
Fluent Assertions Documentation
FluentAssertions.Collections Namespace / GenericCollectionAssertions<TCollection,T,TAssertions> Class / BeEquivalentTo Method / BeEquivalentTo<TExpectation>(IEnumerable<TExpectation>,Func<EquivalencyOptions<TExpectation>,EquivalencyOptions<TExpectation>>,String,Object[]) Method
An IEnumerable with the expected elements.
A reference to the FluentAssertions.Equivalency.EquivalencyOptions<TExpectation> configuration object that can be used to influence the way the object graphs are compared. You can also provide an alternative instance of the FluentAssertions.Equivalency.EquivalencyOptions<TExpectation> class. The global defaults are determined by the FluentAssertions.AssertionConfiguration class.
A formatted phrase as is supported by System.String.Format(System.String,System.Object[]) explaining why the assertion is needed. If the phrase does not start with the word because, it is prepended automatically.
Zero or more objects to format using the placeholders in because.
In This Topic
    BeEquivalentTo<TExpectation>(IEnumerable<TExpectation>,Func<EquivalencyOptions<TExpectation>,EquivalencyOptions<TExpectation>>,String,Object[]) Method
    In This Topic
    Asserts that a collection of objects is equivalent to another collection of objects.
    Syntax
    public AndConstraint<TAssertions> BeEquivalentTo<TExpectation>( 
   IEnumerable<TExpectation> expectation,
   Func<EquivalencyOptions<TExpectation>,EquivalencyOptions<TExpectation>> config,
   string because,
   params object[] becauseArgs
)

    Parameters

    expectation
    An IEnumerable with the expected elements.
    config
    A reference to the FluentAssertions.Equivalency.EquivalencyOptions<TExpectation> configuration object that can be used to influence the way the object graphs are compared. You can also provide an alternative instance of the FluentAssertions.Equivalency.EquivalencyOptions<TExpectation> class. The global defaults are determined by the FluentAssertions.AssertionConfiguration class.
    because
    A formatted phrase as is supported by System.String.Format(System.String,System.Object[]) explaining why the assertion is needed. If the phrase does not start with the word because, it is prepended automatically.
    becauseArgs
    Zero or more objects to format using the placeholders in because.

    Type Parameters

    TExpectation
    Exceptions
    ExceptionDescription
    System.ArgumentNullExceptionconfig is a null reference (Nothing in Visual Basic).
    Remarks
    Objects within the collections are equivalent when both object graphs have equally named properties with the same value, irrespective of the type of those objects. Two properties are also equal if one type can be converted to another and the result is equal. The type of a collection property is ignored as long as the collection implements IEnumerable and all items in the collection are structurally equal. Notice that actual behavior is determined by the global defaults managed by FluentAssertions.AssertionConfiguration.
    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also

    Reference

    GenericCollectionAssertions<TCollection,T,TAssertions> Class
    GenericCollectionAssertions<TCollection,T,TAssertions> Members
    Overload List

    Send Feedback