EntityCollection<TEntity>.Remove(TEntity) Método

Definición

Espacio de nombres:

System.Data.Objects.DataClasses

Ensamblado:

System.Data.Entity.dll

Quita un objeto de la colección y marca la relación para eliminació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

Parámetros

entity

TEntity

Objeto que se quitará de la colección.

Devoluciones

Boolean

Es true si el elemento se quitó correctamente; de lo contrario, es false.

Implementaciones

Remove(T)

Excepciones

ArgumentNullException

El objeto entity es null.

InvalidOperationException

El objeto entity no está asociado al mismo contexto del objeto.

o bien

El objeto entity no tiene un administrador de relaciones válido.

Ejemplos

Este ejemplo se basa en el modelo Adventure Works Sales. Para ejecutar el código de este ejemplo, debe haber agregado ya el modelo AdventureWorks Sales al proyecto y haber configurado el proyecto para que use Entity Framework. Para ello, complete los procedimientos descritos en How to: Manually Configure an Entity Framework Project (Cómo: Configurar manualmente un proyecto de Entity Framework ) y How to: Manually Define the Model and Mapping Files (Cómo: Definir manualmente los archivos de modelo y asignación).

En este ejemplo, se usa el método Remove para quitar una de las entidades de la colección y, a continuación, llama al método Contains para determinar si el objeto se ha quitado de la colección.

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);
    }
}

Comentarios

El método Remove también elimina la relación entre el objeto de origen y el objeto que se va a quitar de la colección. Si la relación tiene una restricción de integridad referencial, al llamar al método Remove en un objeto dependiente, se marcan para eliminación tanto la relación como el objeto dependiente. Esto ocurre porque la restricción indica que el objeto dependiente no puede existir sin una relación con el objeto primario. Para obtener más información, vea Elemento ReferentialConstraint (CSDL).

Remove devuelve false cuando el objeto especificado no está en la colección.