EntityReference.xml

<Type Name="EntityReference" FullName="System.Data.Objects.DataClasses.EntityReference">
  <TypeSignature Language="C#" Value="public abstract class EntityReference : System.Data.Objects.DataClasses.RelatedEnd" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract serializable beforefieldinit EntityReference extends System.Data.Objects.DataClasses.RelatedEnd" />
  <TypeSignature Language="DocId" Value="T:System.Data.Objects.DataClasses.EntityReference" />
  <TypeSignature Language="VB.NET" Value="Public MustInherit Class EntityReference&#xA;Inherits RelatedEnd" />
  <TypeSignature Language="F#" Value="type EntityReference = class&#xA;    inherit RelatedEnd" />
  <TypeSignature Language="C++ CLI" Value="public ref class EntityReference abstract : System::Data::Objects::DataClasses::RelatedEnd" />
  <AssemblyInfo>
    <AssemblyName>System.Data.Entity</AssemblyName>
    <AssemblyVersion>3.5.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Data.Objects.DataClasses.RelatedEnd</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName Language="C#">[System.Runtime.Serialization.DataContract]</AttributeName>
      <AttributeName Language="F#">[&lt;System.Runtime.Serialization.DataContract&gt;]</AttributeName>
    </Attribute>
    <Attribute>
      <AttributeName Language="C#">[System.Serializable]</AttributeName>
      <AttributeName Language="F#">[&lt;System.Serializable&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>Base class that implements non-generic functionality for an <see cref="T:System.Data.Objects.DataClasses.EntityReference`1" />.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The <xref:System.Data.Objects.DataClasses.EntityReference> class exposes the <xref:System.Data.EntityKey> of the related object and is a base class for the <xref:System.Data.Objects.DataClasses.EntityReference%601> class. An <xref:System.Data.Objects.DataClasses.EntityReference%601> object is returned by a navigation property when the related end has a multiplicity of zero or one. For more information, see [NavigationProperty Element (CSDL)](https://msdn.microsoft.com/library/5829a238-a50e-4c81-901d-7b54fc00f27e).  
  
 ]]></format>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected EntityReference ();" FrameworkAlternate="netframework-3.5" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" FrameworkAlternate="netframework-3.5" />
      <MemberSignature Language="DocId" Value="M:System.Data.Objects.DataClasses.EntityReference.#ctor" FrameworkAlternate="netframework-3.5" />
      <MemberSignature Language="VB.NET" Value="Protected Sub New ()" FrameworkAlternate="netframework-3.5" />
      <MemberSignature Language="C++ CLI" Value="protected:&#xA; EntityReference();" FrameworkAlternate="netframework-3.5" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Data.Entity</AssemblyName>
        <AssemblyVersion>3.5.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>Initializes a new instance of the <see cref="T:System.Data.Objects.DataClasses.EntityReference" /> class.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="EntityKey">
      <MemberSignature Language="C#" Value="public System.Data.EntityKey EntityKey { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Data.EntityKey EntityKey" />
      <MemberSignature Language="DocId" Value="P:System.Data.Objects.DataClasses.EntityReference.EntityKey" />
      <MemberSignature Language="VB.NET" Value="Public Property EntityKey As EntityKey" />
      <MemberSignature Language="F#" Value="member this.EntityKey : System.Data.EntityKey with get, set" Usage="System.Data.Objects.DataClasses.EntityReference.EntityKey" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Data::EntityKey ^ EntityKey { System::Data::EntityKey ^ get(); void set(System::Data::EntityKey ^ value); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Data.Entity</AssemblyName>
        <AssemblyVersion>3.5.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.Runtime.Serialization.DataMember]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.Serialization.DataMember&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Data.EntityKey</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Returns the key for the related object.</summary>
        <value>An <see cref="T:System.Data.EntityKey" /> that is the key of the related object.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 Having the entity key of the related object available on the <xref:System.Data.Objects.DataClasses.EntityReference> object makes it easier to return information about the related object without having to load it from the data source.  
  
 Exposing the <xref:System.Data.EntityKey> of the related object on the  <xref:System.Data.Objects.DataClasses.EntityReference> object also enables Object Service to dynamically create an association between two attached objects and delete an object without having to load the related ends. For more information, see [Creating, Adding, Modifying, and Deleting Objects](https://docs.microsoft.com/previous-versions/dotnet/netframework-4.0/bb738695(v=vs.100)).  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
  </Members>
</Type>