EntityCollection<TEntity>.Remove(TEntity) Metoda

Definice

Obor názvů:

System.Data.Objects.DataClasses

Sestavení:

System.Data.Entity.dll

Odebere objekt z kolekce a označí relaci pro odstranění.

public:
 virtual bool Remove(TEntity entity);

public bool Remove(TEntity entity);

override this.Remove : 'Entity -> bool

Public Function Remove (entity As TEntity) As Boolean

Parametry

entity

TEntity

Objekt, který chcete odebrat z kolekce.

Návraty

Boolean

truepokud byla položka úspěšně odebrána; v opačném případě . false

Implementuje

Remove(T)

Výjimky

ArgumentNullException

entity objekt je null.

InvalidOperationException

Objekt entity není připojen ke stejnému kontextu objektu.

nebo

Objekt entity nemá platného správce relací.

Příklady

Tento příklad je založený na prodejním modelu Adventure Works. Pokud chcete kód spustit v tomto příkladu, musíte už do projektu přidat model AdventureWorks Sales Model a nakonfigurovat ho tak, aby používal Entity Framework. Provedete to tak, že dokončíte postupy v : Ruční konfigurace Project a : Ruční definování souborů modelu a mapování.

Tento příklad používá metodu Remove k odebrání jedné z entit z kolekce a potom volá metodu Contains k určení, zda byl objekt odebrán z kolekce.

using (AdventureWorksEntities context =
    new AdventureWorksEntities())
{
    Contact contact = new Contact();

    // Create a new SalesOrderHeader.
    SalesOrderHeader newSalesOrder1 = new SalesOrderHeader();
    // Add SalesOrderHeader to the Contact.
    contact.SalesOrderHeaders.Add(newSalesOrder1);

    // Create another SalesOrderHeader.
    SalesOrderHeader newSalesOrder2 = new SalesOrderHeader();
    // Add SalesOrderHeader to the Contact.
    contact.SalesOrderHeaders.Add(newSalesOrder2);

    // Get all related ends
    IEnumerable<IRelatedEnd> relEnds =
        ((IEntityWithRelationships)contact)
        .RelationshipManager.GetAllRelatedEnds();

    foreach (IRelatedEnd relEnd in relEnds)
    {
        // Get Entity Collection from related end
        EntityCollection<SalesOrderHeader> entityCollection =
            (EntityCollection<SalesOrderHeader>)relEnd;

        Console.WriteLine("EntityCollection count: {0}",
            entityCollection.Count);
        // Remove the first entity object.
        entityCollection.Remove(newSalesOrder1);

        bool contains = entityCollection.Contains(newSalesOrder1);

        // Write the number of items after one entity has been removed
        Console.WriteLine("EntityCollection count after one entity has been removed: {0}",
            entityCollection.Count);

        if (!contains)
            Console.WriteLine("The removed entity is not in in the collection any more.");

        //Use IRelatedEnd to add the entity back.
        relEnd.Add(newSalesOrder1);
        Console.WriteLine("EntityCollection count after an entity has been added again: {0}",
            entityCollection.Count);
    }
}

Poznámky

Metoda Remove také odstraní vztah mezi zdrojovým objektem a objektem, který je odebrán z kolekce. Pokud relace má omezení referenční integrity, volání Remove metody pro závislý objekt označí relaci i závislý objekt pro odstranění. K tomu dochází, protože omezení indikuje, že závislý objekt nemůže existovat bez relace s nadřazeným objektem. Další informace naleznete v tématu ReferentialConstraint – element (CSDL).

Remove vrátí false , pokud zadaný objekt není v kolekci.