EntityCollection<TEntity>.Remove(TEntity) Метод

Определение

Пространство имен:

System.Data.Objects.DataClasses

Сборка:

System.Data.Entity.dll

Удаляет объект из коллекции и помечает связь для удаления.

public:
 virtual bool Remove(TEntity entity);

public bool Remove(TEntity entity);

override this.Remove : 'Entity -> bool

Public Function Remove (entity As TEntity) As Boolean

Параметры

entity

TEntity

Объект, который нужно удалить из коллекции.

Возвращаемое значение

Boolean

Значение в противном случае .

Реализации

Remove(T)

Исключения

ArgumentNullException

entityобъект .null

InvalidOperationException

Объект entity не присоединен к тому же контексту объекта.

–или–

У entity объекта нет допустимого диспетчера связей.

Примеры

Этот пример основан на модели Adventure Works Sales. Чтобы запустить код в этом примере, необходимо добавить модель продаж AdventureWorks в проект и настроить проект для использования Entity Framework. Для этого выполните процедуры в How to: Вручную настройте entity Framework Project и How to: Manually Define the Model and Mapping Files.

В этом примере метод используется Remove для удаления одной из сущностей из коллекции, а затем вызывает Contains метод, чтобы определить, был ли объект удален из коллекции.

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

Комментарии

Метод Remove также удаляет связь между исходным объектом и объектом, удаленным из коллекции. Если у связи есть ограничение целостности ссылок, вызов Remove метода для зависимого объекта помечает связь и зависимый объект для удаления. Это происходит, так как ограничение указывает на то, что зависимый объект не может существовать без связи с родительским объектом. Дополнительные сведения см. в разделе "Элемент ReferentialConstraint" (CSDL).

Remove возвращает, false если указанный объект не находится в коллекции.