NavigationProperty.xml

<Type Name="NavigationProperty" FullName="System.Data.Metadata.Edm.NavigationProperty">
  <TypeSignature Language="C#" Value="public sealed class NavigationProperty : System.Data.Metadata.Edm.EdmMember" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit NavigationProperty extends System.Data.Metadata.Edm.EdmMember" />
  <TypeSignature Language="DocId" Value="T:System.Data.Metadata.Edm.NavigationProperty" />
  <TypeSignature Language="VB.NET" Value="Public NotInheritable Class NavigationProperty&#xA;Inherits EdmMember" />
  <TypeSignature Language="F#" Value="type NavigationProperty = class&#xA;    inherit EdmMember" />
  <TypeSignature Language="C++ CLI" Value="public ref class NavigationProperty sealed : System::Data::Metadata::Edm::EdmMember" />
  <AssemblyInfo>
    <AssemblyName>System.Data.Entity</AssemblyName>
    <AssemblyVersion>3.5.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Data.Metadata.Edm.EdmMember</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>Represents the navigation from one entity type to another entity type in the conceptual model .</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[  
  
## Remarks  
 For more information about how to use the <xref:System.Data.Metadata.Edm.NavigationProperty> in a conceptual model, see [NavigationProperty element (CSDL)](/ef/ef6/modeling/designer/advanced/edmx/csdl-spec#navigationproperty-element-csdl).
  
 ]]></format>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName="BuiltInTypeKind">
      <MemberSignature Language="C#" Value="public override System.Data.Metadata.Edm.BuiltInTypeKind BuiltInTypeKind { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Data.Metadata.Edm.BuiltInTypeKind BuiltInTypeKind" />
      <MemberSignature Language="DocId" Value="P:System.Data.Metadata.Edm.NavigationProperty.BuiltInTypeKind" />
      <MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property BuiltInTypeKind As BuiltInTypeKind" />
      <MemberSignature Language="F#" Value="member this.BuiltInTypeKind : System.Data.Metadata.Edm.BuiltInTypeKind" Usage="System.Data.Metadata.Edm.NavigationProperty.BuiltInTypeKind" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; virtual property System::Data::Metadata::Edm::BuiltInTypeKind BuiltInTypeKind { System::Data::Metadata::Edm::BuiltInTypeKind get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Data.Entity</AssemblyName>
        <AssemblyVersion>3.5.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Data.Metadata.Edm.BuiltInTypeKind</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the built-in type kind for this <see cref="T:System.Data.Metadata.Edm.NavigationProperty" />.</summary>
        <value>A <see cref="T:System.Data.Metadata.Edm.BuiltInTypeKind" /> object that represents the built-in type kind for this <see cref="T:System.Data.Metadata.Edm.NavigationProperty" />.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="FromEndMember">
      <MemberSignature Language="C#" Value="public System.Data.Metadata.Edm.RelationshipEndMember FromEndMember { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Data.Metadata.Edm.RelationshipEndMember FromEndMember" />
      <MemberSignature Language="DocId" Value="P:System.Data.Metadata.Edm.NavigationProperty.FromEndMember" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property FromEndMember As RelationshipEndMember" />
      <MemberSignature Language="F#" Value="member this.FromEndMember : System.Data.Metadata.Edm.RelationshipEndMember" Usage="System.Data.Metadata.Edm.NavigationProperty.FromEndMember" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Data::Metadata::Edm::RelationshipEndMember ^ FromEndMember { System::Data::Metadata::Edm::RelationshipEndMember ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Data.Entity</AssemblyName>
        <AssemblyVersion>3.5.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Data.Metadata.Edm.RelationshipEndMember</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the "from" relationship end member in this navigation.</summary>
        <value>The "from" relationship end member in this navigation.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetDependentProperties">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable&lt;System.Data.Metadata.Edm.EdmProperty&gt; GetDependentProperties ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.IEnumerable`1&lt;class System.Data.Metadata.Edm.EdmProperty&gt; GetDependentProperties() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Data.Metadata.Edm.NavigationProperty.GetDependentProperties" />
      <MemberSignature Language="VB.NET" Value="Public Function GetDependentProperties () As IEnumerable(Of EdmProperty)" />
      <MemberSignature Language="F#" Value="member this.GetDependentProperties : unit -&gt; seq&lt;System.Data.Metadata.Edm.EdmProperty&gt;" Usage="navigationProperty.GetDependentProperties " />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; System::Collections::Generic::IEnumerable&lt;System::Data::Metadata::Edm::EdmProperty ^&gt; ^ GetDependentProperties();" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Data.Entity</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IEnumerable&lt;System.Data.Metadata.Edm.EdmProperty&gt;</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Gets the foreign key properties for a navigation property that is on the dependent end of a referential constraint.</summary>
        <returns>A collection of the foreign key properties.</returns>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 For a navigation property that is on the dependent end of a referential constraint, the <xref:System.Data.Metadata.Edm.NavigationProperty.GetDependentProperties%2A> method returns the corresponding foreign key properties. The returned properties will be in the same order as the principal end key properties.  
  
 If the navigation property is not on the dependent end of a referential constraint, the <xref:System.Data.Metadata.Edm.NavigationProperty.GetDependentProperties%2A> method returns an empty collection.  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="RelationshipType">
      <MemberSignature Language="C#" Value="public System.Data.Metadata.Edm.RelationshipType RelationshipType { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Data.Metadata.Edm.RelationshipType RelationshipType" />
      <MemberSignature Language="DocId" Value="P:System.Data.Metadata.Edm.NavigationProperty.RelationshipType" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property RelationshipType As RelationshipType" />
      <MemberSignature Language="F#" Value="member this.RelationshipType : System.Data.Metadata.Edm.RelationshipType" Usage="System.Data.Metadata.Edm.NavigationProperty.RelationshipType" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Data::Metadata::Edm::RelationshipType ^ RelationshipType { System::Data::Metadata::Edm::RelationshipType ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Data.Entity</AssemblyName>
        <AssemblyVersion>3.5.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Data.Metadata.Edm.RelationshipType</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the relationship type that this navigation property operates on.</summary>
        <value>The relationship type that this navigation property operates on.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ToEndMember">
      <MemberSignature Language="C#" Value="public System.Data.Metadata.Edm.RelationshipEndMember ToEndMember { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Data.Metadata.Edm.RelationshipEndMember ToEndMember" />
      <MemberSignature Language="DocId" Value="P:System.Data.Metadata.Edm.NavigationProperty.ToEndMember" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property ToEndMember As RelationshipEndMember" />
      <MemberSignature Language="F#" Value="member this.ToEndMember : System.Data.Metadata.Edm.RelationshipEndMember" Usage="System.Data.Metadata.Edm.NavigationProperty.ToEndMember" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Data::Metadata::Edm::RelationshipEndMember ^ ToEndMember { System::Data::Metadata::Edm::RelationshipEndMember ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Data.Entity</AssemblyName>
        <AssemblyVersion>3.5.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Data.Metadata.Edm.RelationshipEndMember</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the "to" relationship end member of this navigation.</summary>
        <value>The "to" relationship end member of this navigation.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>