EntityCollection<TEntity>.Remove(TEntity) Metode

Definisi

Ruang nama:

System.Data.Objects.DataClasses

Rakitan:

System.Data.Entity.dll

Menghapus objek dari koleksi dan menandai hubungan untuk penghapusan.

public:
 virtual bool Remove(TEntity entity);

public bool Remove (TEntity entity);

override this.Remove : 'Entity -> bool

Public Function Remove (entity As TEntity) As Boolean

Parameter

entity

TEntity

Objek yang akan dihapus dari koleksi.

Mengembalikan

Boolean

true jika item berhasil dihapus; jika tidak, false.

Penerapan

Remove(T)

Pengecualian

ArgumentNullException

entity objek adalah null.

InvalidOperationException

Objek entity tidak dilampirkan ke konteks objek yang sama.

-atau-

Objek entity tidak memiliki pengelola hubungan yang valid.

Contoh

Contoh ini didasarkan pada Model Penjualan Adventure Works. Untuk menjalankan kode dalam contoh ini, Anda harus telah menambahkan Model Penjualan AdventureWorks ke proyek Anda dan mengonfigurasi proyek Anda untuk menggunakan Kerangka Kerja Entitas. Untuk melakukan ini, selesaikan prosedur dalam Cara: Mengonfigurasi Proyek Kerangka Kerja Entitas secara Manual dan Cara: Menentukan Model dan File Pemetaan secara Manual.

Contoh ini menggunakan Remove metode untuk menghapus salah satu entitas dari koleksi lalu memanggil Contains metode untuk menentukan apakah objek dihapus dari koleksi.

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

Keterangan

Metode ini Remove juga menghapus hubungan antara objek sumber dan objek yang dihapus dari koleksi. Jika hubungan memiliki batasan integritas referensial, memanggil Remove metode pada objek dependen menandai hubungan dan objek dependen untuk penghapusan. Ini terjadi karena batasan menunjukkan bahwa objek dependen tidak dapat ada tanpa hubungan dengan induk. Untuk informasi selengkapnya, lihat ReferentialConstraint Element (CSDL).

Remove false mengembalikan ketika objek yang ditentukan tidak ada dalam koleksi.