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

如果成功移除了该项，则为 true；否则为 false。

实现

Remove(T)

例外

ArgumentNullException

entity 对象为 null。

InvalidOperationException

entity 对象没有附加到同一对象上下文。

- 或 -

entity 对象没有有效的关系管理器。

示例

此示例基于 Adventure Works 销售模型。 若要运行此示例中的代码，必须已将 AdventureWorks 销售模型添加到您的项目中，并将项目配置为使用实体框架。 为此，请完成 如何：手动配置实体框架项目 和 如何：手动定义模型和映射文件中的过程。

本示例使用 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当指定的 对象不在集合中时返回 。