This documentation is archived and is not being maintained.

IRelatedEnd.Remove Method (IEntityWithRelationships)

Removes an object from the collection of objects at the related end.

Namespace:  System.Data.Objects.DataClasses
Assembly:  System.Data.Entity (in System.Data.Entity.dll)

bool Remove(
	IEntityWithRelationships entity


Type: System.Data.Objects.DataClasses.IEntityWithRelationships
The object to remove from the collection. entity must implement IEntityWithRelationships.

Return Value

Type: System.Boolean
true if entity was successfully removed, false if entity was not part of the IRelatedEnd.

The Remove method removes an object from the related end. The related end must be an EntityCollection<TEntity>.

The RelatedEnd class explicitly implements the Remove method. The EntityCollection<TEntity> class uses this implementation. For more information, see Remove.

.NET Framework

Supported in: 4, 3.5 SP1

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.