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 su 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 va a quitar de la colección.

Devoluciones

Boolean

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

Implementaciones

Remove(T)

Excepciones

ArgumentNullException

entity el objeto es null.

InvalidOperationException

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

O bien

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

Ejemplos

Este ejemplo se basa en el modelo de ventas de Adventure Works. Para ejecutar el código en este ejemplo, debe haber agregado el modelo de ventas de AdventureWorks al proyecto y configurado el proyecto para usar Entity Framework. Para ello, complete los procedimientos de Cómo: Configurar manualmente una Project y Cómo: Definir manualmente los archivos de modelo y asignación.

En este ejemplo se usa el Remove método para quitar una de las entidades de la colección y, a continuación, se llama al Contains método para determinar si el objeto se quitó 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)
            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 Remove método también elimina la relación entre el objeto de origen y el objeto que se quita de la colección. Si la relación tiene una restricción de integridad referencial, llamar al Remove método en un objeto dependiente marca la relación y el objeto dependiente para su eliminación. Esto ocurre porque la restricción indica que el objeto dependiente no puede existir sin una relación con el elemento primario. Para obtener más información, vea Elemento ReferentialConstraint (CSDL) .

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

Se aplica a