IReadOnlyNavigation Interface

Reference

Definition

Namespace:: Microsoft.EntityFrameworkCore.Metadata

Assembly:: Microsoft.EntityFrameworkCore.dll

Package:: Microsoft.EntityFrameworkCore v6.0.0

Package:: Microsoft.EntityFrameworkCore v7.0.0

Package:: Microsoft.EntityFrameworkCore v8.0.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public interface IReadOnlyNavigation : Microsoft.EntityFrameworkCore.Metadata.IReadOnlyNavigationBase

type IReadOnlyNavigation = interface
    interface IReadOnlyNavigationBase
    interface IReadOnlyPropertyBase
    interface IReadOnlyAnnotatable

Public Interface IReadOnlyNavigation
Implements IReadOnlyNavigationBase

Derived: Microsoft.EntityFrameworkCore.Metadata.IConventionNavigation

Microsoft.EntityFrameworkCore.Metadata.IMutableNavigation

Microsoft.EntityFrameworkCore.Metadata.INavigation

Microsoft.EntityFrameworkCore.Metadata.RuntimeNavigation

Implements: IReadOnlyAnnotatable 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.
IsCollection	Gets a value indicating whether the navigation property is a collection property.
IsEagerLoaded	Gets a value indicating whether this navigation should be eager loaded by default. (Inherited from IReadOnlyNavigationBase)
IsOnDependent	Gets a value indicating whether the navigation property is defined on the dependent side of the underlying foreign key.
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

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)
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)
GetFieldName()	Gets the name of the backing field for this property, or `null` if the backing field is not known. (Inherited from IReadOnlyPropertyBase)
GetPropertyAccessMode()	Gets the PropertyAccessMode being used for this property-like object. (Inherited from IReadOnlyPropertyBase)
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)
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.

Explicit Interface Implementations

IReadOnlyNavigationBase.DeclaringEntityType	Gets the entity type that this navigation property belongs to.
IReadOnlyNavigationBase.Inverse	Gets the inverse navigation.
IReadOnlyNavigationBase.IsCollection	Gets a value indicating whether the navigation property is a collection property.
IReadOnlyNavigationBase.TargetEntityType	Gets the entity type that this navigation property will hold an instance(s) of.
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)

Applies to