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 Sales Model。 若要執行此範例中的程式碼，您必須已經將 AdventureWorks Sales Model 加入到專案中，並設定您的專案使用 Entity Framework。 若要這樣做，請完成 如何：手動設定 Entity Framework 專案 和 如何：手動定義模型和對應檔案中的程式。

這個範例會使用 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 == 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);
    }
}

備註

Remove 方法也會刪除來源物件與從集合中移除之物件之間的關聯性。 如果此關聯性具有參考完整性 (Referential Integrity) 條件約束 (Constraint)，針對相依物件呼叫 Remove 方法就會同時將此關聯性和相依物件標記為待刪除。 發生這種情況的原因是，條件約束表示如果沒有父代 (Parent) 的關聯性，相依物件就無法存在。 如需詳細資訊，請參閱 參考ialConstraint 元素 (CSDL) 。

Remove false當指定的物件不在集合中時，會傳回 。