INavigation Interface

Definition

Namespace:

Microsoft.EntityFrameworkCore.Metadata

Assembly:

Microsoft.EntityFrameworkCore.dll

Package:

Microsoft.EntityFrameworkCore v9.0.0

Source:

INavigation.cs

Represents a navigation property which can be used to navigate a relationship.

public interface INavigation : Microsoft.EntityFrameworkCore.Metadata.INavigationBase, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyNavigation

type INavigation = interface
    interface IReadOnlyNavigation
    interface IReadOnlyNavigationBase
    interface IReadOnlyPropertyBase
    interface IReadOnlyAnnotatable
    interface INavigationBase
    interface IPropertyBase
    interface IAnnotatable

Public Interface INavigation
Implements INavigationBase, IReadOnlyNavigation

Derived

Microsoft.EntityFrameworkCore.Metadata.RuntimeNavigation

Implements

IAnnotatable IPropertyBase INavigationBase IReadOnlyAnnotatable IReadOnlyNavigation IReadOnlyNavigationBase IReadOnlyPropertyBase

Remarks

See Modeling entity types and relationships for more information and examples.

Properties

ClrType	Gets the type of value that this property-like object holds. (Inherited from IReadOnlyPropertyBase)
DeclaringEntityType	Gets the entity type that this navigation property belongs to.
DeclaringType	Gets the type that this property-like object belongs to. (Inherited from IReadOnlyPropertyBase)
FieldInfo	Gets the FieldInfo for the underlying CLR field for this property-like object. This may be null for shadow properties or if the backing field is not known. (Inherited from IReadOnlyPropertyBase)
ForeignKey	Gets the foreign key that defines the relationship this navigation property will navigate.
Inverse	Gets the inverse navigation.
Item[String]	Gets the value of the annotation with the given name, returning null if it does not exist. (Inherited from IReadOnlyAnnotatable)
LazyLoadingEnabled	Determines whether or not this navigation should lazy-load if lazy-loading is enabled and a mechanism for lazy-loading has been configured in the model. (Inherited from IReadOnlyNavigationBase)
Name	Gets the name of this property-like object. (Inherited from IReadOnlyPropertyBase)
PropertyInfo	Gets the PropertyInfo for the underlying CLR property for this property-like object. This may be null for shadow properties or if mapped directly to a field. (Inherited from IReadOnlyPropertyBase)
Sentinel	Gets the sentinel value that indicates that this property is not set. (Inherited from IReadOnlyPropertyBase)
TargetEntityType	Gets the entity type that this navigation property will hold an instance(s) of.

Methods

AddRuntimeAnnotation(String, Object)	Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from IAnnotatable)
AnnotationsToDebugString(Int32)	Gets the debug string for all annotations declared on the object. (Inherited from IReadOnlyAnnotatable)
FindAnnotation(String)	Gets the annotation with the given name, returning null if it does not exist. (Inherited from IReadOnlyAnnotatable)
FindRuntimeAnnotation(String)	Gets the runtime annotation with the given name, returning null if it does not exist. (Inherited from IAnnotatable)
FindRuntimeAnnotationValue(String)	Gets the value of the runtime annotation with the given name, returning null if it does not exist. (Inherited from IAnnotatable)
GetAnnotation(String)	Gets the annotation with the given name, throwing if it does not exist. (Inherited from IReadOnlyAnnotatable)
GetAnnotations()	Gets all annotations on the current object. (Inherited from IReadOnlyAnnotatable)
GetCurrentValueComparer()	Gets a IComparer<T> for comparing values in tracked IUpdateEntry entries. (Inherited from IPropertyBase)
GetFieldName()	Gets the name of the backing field for this property, or null if the backing field is not known. (Inherited from IReadOnlyPropertyBase)
GetGetter()	Gets a IClrPropertyGetter for reading the value of this property. (Inherited from IPropertyBase)
GetIndex()	Gets the property index for this property. (Inherited from IPropertyBase)
GetMemberInfo(Boolean, Boolean)	Gets the PropertyInfo or FieldInfo that should be used to get or set a value for the given property. (Inherited from IPropertyBase)
GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg)	Gets the value of the runtime annotation with the given name, adding it if one does not exist. (Inherited from IAnnotatable)
GetPropertyAccessMode()	Gets the PropertyAccessMode being used for this property-like object. (Inherited from IReadOnlyPropertyBase)
GetRuntimeAnnotations()	Gets all the runtime annotations on the current object. (Inherited from IAnnotatable)
IsIndexerProperty()	Gets a value indicating whether this is an indexer property. An indexer property is one that is accessed through an indexer on the entity class. (Inherited from IReadOnlyPropertyBase)
IsShadowProperty()	Gets a value indicating whether this is a shadow property. A shadow property is one that does not have a corresponding property in the entity class. The current value for the property is stored in the ChangeTracker rather than being stored in instances of the entity class. (Inherited from IReadOnlyPropertyBase)
RemoveRuntimeAnnotation(String)	Removes the given runtime annotation from this object. (Inherited from IAnnotatable)
SetIsLoadedWhenNoTracking(Object)	Calls SetLoaded(Object, String, Boolean) for a INavigationBase to mark it as loaded when a no-tracking query has eagerly loaded this relationship. (Inherited from INavigationBase)
SetRuntimeAnnotation(String, Object)	Sets the runtime annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists. (Inherited from IAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)	Creates a human-readable representation of the given metadata. Warning: Do not rely on the format of the returned string. It is designed for debugging only and may change arbitrarily between releases. (Inherited from IReadOnlyNavigation)

Explicit Interface Implementations

IReadOnlyNavigationBase.DeclaringEntityType	Gets the entity type that this navigation property belongs to. (Inherited from IReadOnlyNavigation)
IReadOnlyNavigationBase.Inverse	Gets the inverse navigation. (Inherited from IReadOnlyNavigation)
IReadOnlyNavigationBase.IsCollection	Gets a value indicating whether the navigation property is a collection property. (Inherited from IReadOnlyNavigation)
IReadOnlyNavigationBase.TargetEntityType	Gets the entity type that this navigation property will hold an instance(s) of. (Inherited from IReadOnlyNavigation)
IReadOnlyPropertyBase.IsShadowProperty()	Gets a value indicating whether this is a shadow property. A shadow property is one that does not have a corresponding property in the entity class. The current value for the property is stored in the ChangeTracker rather than being stored in instances of the entity class. (Inherited from IReadOnlyNavigationBase)

Extension Methods

GetDataAnnotations(INavigation, IAnnotationCodeGenerator)

Gets the data annotations to configure a navigation property.