Edit

IRelatedEnd.Remove Method

  • Reference

Definition

Namespace:
System.Data.Objects.DataClasses
Assembly:
System.Data.Entity.dll

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

Overloads

Remove(IEntityWithRelationships)

Removes an object from the collection of objects at the related end.
Remove(Object)

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

Remove(IEntityWithRelationships)

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

public:
 bool Remove(System::Data::Objects::DataClasses::IEntityWithRelationships ^ entity);
public bool Remove (System.Data.Objects.DataClasses.IEntityWithRelationships entity);
abstract member Remove : System.Data.Objects.DataClasses.IEntityWithRelationships -> bool
Public Function Remove (entity As IEntityWithRelationships) As Boolean

Parameters

entity
IEntityWithRelationships

The object to remove from the collection. entity must implement IEntityWithRelationships.

Returns

Boolean

true if entity was successfully removed, false if entity was not part of the IRelatedEnd.

Remarks

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.

Applies to

Remove(Object)

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

public:
 bool Remove(System::Object ^ entity);
public bool Remove (object entity);
abstract member Remove : obj -> bool
Public Function Remove (entity As Object) As Boolean

Parameters

entity
Object

An object to remove from the collection.

Returns

Boolean

true if entity was successfully removed; false if entity was not part of the IRelatedEnd.

Remarks

Use this method overload for entity classes that do not implement IEntityWithRelationships. Use the Remove method for entity classes that do implement IEntityWithRelationships.

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.

Applies to