EntityCollection<TEntity>.Remove(TEntity) Metoda

Definicja

Usuwa obiekt z kolekcji i oznacza relację do usunięcia.Removes an object from the collection and marks the relationship for deletion.

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

Obiekt do usunięcia z kolekcji.The object to remove from the collection.

Zwraca

Boolean

true Jeśli element został pomyślnie usunięty; w przeciwnym razie false .true if item was successfully removed; otherwise, false.

Implementuje

Wyjątki

entity Obiekt jest null .entity object is null.

entityObiekt nie jest dołączony do tego samego kontekstu obiektu.The entity object is not attached to the same object context.

-lub--or-

entityObiekt nie ma prawidłowego Menedżera relacji.The entity object does not have a valid relationship manager.

Przykłady

Ten przykład jest oparty na modelu sprzedaży Adventure Works.This example is based on the Adventure Works Sales Model. Aby uruchomić kod w tym przykładzie, musisz już dodać model sprzedaży AdventureWorks do projektu i skonfigurować projekt do korzystania z Entity Framework.To run the code in this example, you must have already added the AdventureWorks Sales Model to your project and configured your project to use the Entity Framework. Aby to zrobić, wykonaj procedury opisane w temacie jak: ręcznie skonfigurować projekt Entity Framework i instrukcje: ręcznie zdefiniować model i pliki mapowania.To do this, complete the procedures in How to: Manually Configure an Entity Framework Project and How to: Manually Define the Model and Mapping Files.

W tym przykładzie użyto Remove metody, aby usunąć jedną z jednostek z kolekcji, a następnie wywołuje Contains metodę, aby określić, czy obiekt został usunięty z kolekcji.This example uses the Remove method to remove one of the entities from the collection and then calls the Contains method to determine whether the object was removed from the collection.

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 == false)
            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);
    }
}
Using context As New AdventureWorksEntities()
    Dim contact As New Contact()

    ' Create a new SalesOrderHeader. 
    Dim newSalesOrder1 As New SalesOrderHeader()
    ' Add SalesOrderHeader to the Contact. 
    contact.SalesOrderHeaders.Add(newSalesOrder1)

    ' Create another SalesOrderHeader. 
    Dim newSalesOrder2 As New SalesOrderHeader()
    ' Add SalesOrderHeader to the Contact. 
    contact.SalesOrderHeaders.Add(newSalesOrder2)

    ' Get all related ends 
    Dim relEnds As IEnumerable(Of IRelatedEnd) = DirectCast(contact, IEntityWithRelationships).RelationshipManager.GetAllRelatedEnds()

    For Each relEnd As IRelatedEnd In relEnds
        ' Get Entity Collection from related end 
        Dim entityCollection As EntityCollection(Of SalesOrderHeader) = DirectCast(relEnd, EntityCollection(Of SalesOrderHeader))

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

        Dim contains As Boolean = 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 = False Then
            Console.WriteLine("The removed entity is not in in the collection any more.")
        End If

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

Uwagi

RemoveMetoda usuwa również relację między obiektem źródłowym a obiektem usuwanym z kolekcji.The Remove method also deletes the relationship between the source object and the object being removed from the collection. Jeśli relacja ma ograniczenie integralności referencyjnej, wywołanie Remove metody dla obiektu zależnego oznacza relację i obiekt zależny do usunięcia.If the relationship has a referential integrity constraint, calling the Remove method on a dependent object marks both the relationship and the dependent object for deletion. Dzieje się tak, ponieważ ograniczenie wskazuje, że obiekt zależny nie może istnieć bez relacji z elementem nadrzędnym.This occurs because the constraint indicates that the dependent object cannot exist without a relationship to the parent. Aby uzyskać więcej informacji, zobacz ReferentialConstraint element (CSDL).For more information, see ReferentialConstraint Element (CSDL).

Remove zwraca false , gdy określony obiekt nie znajduje się w kolekcji.Remove returns false when the specified object is not in the collection.

Dotyczy