IConventionComplexPropertyBuilder Interface

Reference

Definition

Namespace:: Microsoft.EntityFrameworkCore.Metadata.Builders

Assembly:: Microsoft.EntityFrameworkCore.dll

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.

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

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

public interface IConventionComplexPropertyBuilder : Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionPropertyBaseBuilder<Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionComplexPropertyBuilder>

type IConventionComplexPropertyBuilder = interface
    interface IConventionPropertyBaseBuilder<IConventionComplexPropertyBuilder>
    interface IConventionAnnotatableBuilder

Public Interface IConventionComplexPropertyBuilder
Implements IConventionPropertyBaseBuilder(Of IConventionComplexPropertyBuilder)

Implements: IConventionAnnotatableBuilder IConventionPropertyBaseBuilder<IConventionComplexPropertyBuilder>

Remarks

See Model building conventions for more information and examples.

Properties

Metadata	Gets the property being configured.
ModelBuilder	Gets the model builder. (Inherited from IConventionAnnotatableBuilder)

Methods

CanRemoveAnnotation(String, Boolean)	Returns a value indicating whether an annotation with the given name can be removed using this configuration source. (Inherited from IConventionAnnotatableBuilder)
CanSetAnnotation(String, Object, Boolean)	Returns a value indicating whether an annotation with the given name and value can be set from this configuration source. (Inherited from IConventionAnnotatableBuilder)
CanSetField(FieldInfo, Boolean)	Returns a value indicating whether the backing field can be set for this property-like object from the current configuration source. (Inherited from IConventionPropertyBaseBuilder<TBuilder>)
CanSetField(String, Boolean)	Returns a value indicating whether the backing field can be set for this property-like object from the current configuration source. (Inherited from IConventionPropertyBaseBuilder<TBuilder>)
CanSetIsRequired(Nullable<Boolean>, Boolean)	Returns a value indicating whether this property requiredness can be configured from the current configuration source.
CanSetPropertyAccessMode(Nullable<PropertyAccessMode>, Boolean)	Returns a value indicating whether the PropertyAccessMode can be set for this property-like object from the current configuration source. (Inherited from IConventionPropertyBaseBuilder<TBuilder>)
HasAnnotation(String, Object, Boolean)	Sets the annotation stored under the given name. Overwrites the existing annotation if an annotation with the specified name already exists with same or lower ConfigurationSource. (Inherited from IConventionPropertyBaseBuilder<TBuilder>)
HasField(FieldInfo, Boolean)	Sets the backing field to use for this property-like object. (Inherited from IConventionPropertyBaseBuilder<TBuilder>)
HasField(String, Boolean)	Sets the backing field to use for this property-like object. (Inherited from IConventionPropertyBaseBuilder<TBuilder>)
HasNoAnnotation(String, Boolean)	Removes the annotation with the given name from this object. (Inherited from IConventionPropertyBaseBuilder<TBuilder>)
HasNonNullAnnotation(String, Object, Boolean)	Sets the annotation stored under the given name. Overwrites the existing annotation if an annotation with the specified name already exists with same or lower ConfigurationSource. Removes the annotation if `null` value is specified. (Inherited from IConventionPropertyBaseBuilder<TBuilder>)
IsRequired(Nullable<Boolean>, Boolean)	Configures whether this property must have a value assigned or `null` is a valid value. A property can only be configured as non-required if it is based on a CLR type that can be assigned `null`.
RemoveAnnotation(String, Boolean)	Obsolete. Removes the annotation with the given name from this object. (Inherited from IConventionAnnotatableBuilder)
SetOrRemoveAnnotation(String, Object, Boolean)	Obsolete. Sets or removes the annotation stored under the given name. (Inherited from IConventionAnnotatableBuilder)
UsePropertyAccessMode(Nullable<PropertyAccessMode>, Boolean)	Sets the PropertyAccessMode to use for this property-like object. (Inherited from IConventionPropertyBaseBuilder<TBuilder>)

Applies to