This topic has not yet been rated - Rate this topic

IRelatedEnd Interface

Defines the end of a relationship.

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

The IRelatedEnd type exposes the following members.

  Name Description
Public property IsLoaded Gets a value that indicates whether all related objects have been loaded.
Public property RelationshipName Gets the name of the relationship in which this related end participates.
Public property RelationshipSet Returns a reference to the metadata for the related end.
Public property SourceRoleName Gets the role name at the source end of the relationship.
Public property TargetRoleName Gets the role name at the target end of the relationship.
Top
  Name Description
Public method Add(IEntityWithRelationships) Adds an object to the related end.
Public method Add(Object) Adds an object to the related end.
Public method Attach(IEntityWithRelationships) Defines a relationship between two attached objects.
Public method Attach(Object) Defines a relationship between two attached objects.
Public method CreateSourceQuery Returns an IEnumerable that represents the objects that belong to the related end.
Public method GetEnumerator Returns an IEnumerator that iterates through the collection of related objects.
Public method Load() Loads the related object or objects into this related end with the default merge option.
Public method Load(MergeOption) Loads the related object or objects into the related end with the specified merge option.
Public method Remove(IEntityWithRelationships) Removes an object from the collection of objects at the related end.
Public method Remove(Object) Removes an object from the collection of objects at the related end.
Top

IRelatedEnd defines the requirements for an object that represents an end in an association. This interface is implemented by the RelatedEnd class. RelatedEnd is the base class for the EntityCollection<TEntity> and EntityReference<TEntity> classes.

The example in this topic is based on the Adventure Works Sales Model, which was generated by the Entity Data Model Wizard.

The following example adds new SalesOrderHeader entities to the Contact entity. Then it gets all related ends from the Contact entity and displays relationship name, source role name, and target role name for each related end.


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)
    {
        Console.WriteLine("Relationship Name: {0}", relEnd.RelationshipName);
        Console.WriteLine("Source Role Name: {0}", relEnd.SourceRoleName);
        Console.WriteLine("Target Role Name: {0}", relEnd.TargetRoleName);
    }
}


.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.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ