Interface IConventionNavigationBuilder

Namespace

Microsoft.EntityFrameworkCore.Metadata.Builders

Assembly

Microsoft.EntityFrameworkCore.dll

Provides a simple API surface for configuring an IConventionNavigation from conventions.

This interface is typically used by database providers (and other extensions). It is generally not used in application code.

public interface IConventionNavigationBuilder : IConventionPropertyBaseBuilder<IConventionNavigationBuilder>, IConventionAnnotatableBuilder

Inherited Members

IConventionPropertyBaseBuilder<IConventionNavigationBuilder>.HasAnnotation(string, object, bool)

IConventionPropertyBaseBuilder<IConventionNavigationBuilder>.HasNonNullAnnotation(string, object, bool)

IConventionPropertyBaseBuilder<IConventionNavigationBuilder>.HasNoAnnotation(string, bool)

IConventionPropertyBaseBuilder<IConventionNavigationBuilder>.HasField(string, bool)

IConventionPropertyBaseBuilder<IConventionNavigationBuilder>.HasField(FieldInfo, bool)

IConventionPropertyBaseBuilder<IConventionNavigationBuilder>.CanSetField(string, bool)

IConventionPropertyBaseBuilder<IConventionNavigationBuilder>.CanSetField(FieldInfo, bool)

IConventionPropertyBaseBuilder<IConventionNavigationBuilder>.UsePropertyAccessMode(PropertyAccessMode?, bool)

IConventionPropertyBaseBuilder<IConventionNavigationBuilder>.CanSetPropertyAccessMode(PropertyAccessMode?, bool)

IConventionAnnotatableBuilder.CanSetAnnotation(string, object, bool)

IConventionAnnotatableBuilder.CanRemoveAnnotation(string, bool)

IConventionAnnotatableBuilder.ModelBuilder

Remarks

See Model building conventions for more information and examples.

Properties

Metadata

Gets the navigation being configured.

IConventionNavigation Metadata { get; }

Property Value

IConventionNavigation

Methods

AutoInclude(bool?, bool)

Configures this navigation to be automatically included in a query.

IConventionNavigationBuilder? AutoInclude(bool? autoInclude, bool fromDataAnnotation = false)

Parameters

autoInclude bool?

A value indicating whether the navigation should be automatically included.

fromDataAnnotation bool

Indicates whether the configuration was specified using a data annotation.

Returns

IConventionNavigationBuilder

The same builder instance if the configuration was applied, null otherwise.

CanSetAutoInclude(bool?, bool)

Returns a value indicating whether this navigation can be configured to be automatically included in a query from the current configuration source.

bool CanSetAutoInclude(bool? autoInclude, bool fromDataAnnotation = false)

Parameters

autoInclude bool?

A value indicating whether the navigation should be automatically included.

fromDataAnnotation bool

Indicates whether the configuration was specified using a data annotation.

Returns

bool

true if automatically included can be set for this navigation.

CanSetIsRequired(bool?, bool)

Returns a value indicating whether this navigation requiredness can be configured from the current configuration source.

bool CanSetIsRequired(bool? required, bool fromDataAnnotation = false)

Parameters

required bool?

A value indicating whether the navigation should be required.

fromDataAnnotation bool

Indicates whether the configuration was specified using a data annotation.

Returns

bool

true if requiredness can be set for this navigation.

CanSetLazyLoadingEnabled(bool?, bool)

Returns a value indicating whether this navigation can be configured to enable lazy-loading from the current configuration source.

bool CanSetLazyLoadingEnabled(bool? lazyLoadingEnabled, bool fromDataAnnotation = false)

Parameters

lazyLoadingEnabled bool?

A value indicating whether the navigation should be enabled for lazy-loading.

fromDataAnnotation bool

Indicates whether the configuration was specified using a data annotation.

Returns

bool

true if automatically included can be set for this navigation.

EnableLazyLoading(bool?, bool)

Configures this navigation to be enabled for lazy-loading.

IConventionNavigationBuilder? EnableLazyLoading(bool? lazyLoadingEnabled, bool fromDataAnnotation = false)

Parameters

lazyLoadingEnabled bool?

A value indicating whether the navigation should be enabled for lazy-loading.

fromDataAnnotation bool

Indicates whether the configuration was specified using a data annotation.

Returns

IConventionNavigationBuilder

The same builder instance if the configuration was applied, null otherwise.

IsRequired(bool?, bool)

Configures whether this navigation is required.

IConventionNavigationBuilder? IsRequired(bool? required, bool fromDataAnnotation = false)

Parameters

required bool?

A value indicating whether this is a required navigation. null to reset to default.

fromDataAnnotation bool

Indicates whether the configuration was specified using a data annotation.

Returns

IConventionNavigationBuilder

The same builder instance if the requiredness was configured, null otherwise.