EntityTypeBuilder.Property Method

Definition

Namespace:

Microsoft.EntityFrameworkCore.Metadata.Builders

Assembly:

Microsoft.EntityFrameworkCore.dll

Package:

Microsoft.EntityFrameworkCore v8.0.0

Overloads

Property(String)	Returns an object that can be used to configure a property of the entity type. If no property with the given name exists, then a new property will be added.
Property(Type, String)	Returns an object that can be used to configure a property of the entity type. If no property with the given name exists, then a new property will be added.
Property<TProperty>(String)	Returns an object that can be used to configure a property of the entity type. If no property with the given name exists, then a new property will be added.

Property(String)

Returns an object that can be used to configure a property of the entity type. If no property with the given name exists, then a new property will be added.

public virtual Microsoft.EntityFrameworkCore.Metadata.Builders.PropertyBuilder Property (string propertyName);

abstract member Property : string -> Microsoft.EntityFrameworkCore.Metadata.Builders.PropertyBuilder
override this.Property : string -> Microsoft.EntityFrameworkCore.Metadata.Builders.PropertyBuilder

Public Overridable Function Property (propertyName As String) As PropertyBuilder

Parameters

propertyName

String

The name of the property to be configured.

Returns

PropertyBuilder

An object that can be used to configure the property.

Remarks

When adding a new property with this overload the property name must match the name of a CLR property or field on the entity type. This overload cannot be used to add a new shadow state property.

Property(Type, String)

Returns an object that can be used to configure a property of the entity type. If no property with the given name exists, then a new property will be added.

public virtual Microsoft.EntityFrameworkCore.Metadata.Builders.PropertyBuilder Property (Type propertyType, string propertyName);

abstract member Property : Type * string -> Microsoft.EntityFrameworkCore.Metadata.Builders.PropertyBuilder
override this.Property : Type * string -> Microsoft.EntityFrameworkCore.Metadata.Builders.PropertyBuilder

Public Overridable Function Property (propertyType As Type, propertyName As String) As PropertyBuilder

Parameters

propertyType

Type

The type of the property to be configured.

propertyName

String

The name of the property to be configured.

Returns

PropertyBuilder

An object that can be used to configure the property.

Remarks

When adding a new property, if a property with the same name exists in the entity class then it will be added to the model. If no property exists in the entity class, then a new shadow state property will be added. A shadow state 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.

Property<TProperty>(String)

Returns an object that can be used to configure a property of the entity type. If no property with the given name exists, then a new property will be added.

public virtual Microsoft.EntityFrameworkCore.Metadata.Builders.PropertyBuilder<TProperty> Property<TProperty> (string propertyName);

abstract member Property : string -> Microsoft.EntityFrameworkCore.Metadata.Builders.PropertyBuilder<'Property>
override this.Property : string -> Microsoft.EntityFrameworkCore.Metadata.Builders.PropertyBuilder<'Property>

Public Overridable Function Property(Of TProperty) (propertyName As String) As PropertyBuilder(Of TProperty)

Type Parameters

TProperty

The type of the property to be configured.

Parameters

propertyName

String

The name of the property to be configured.

Returns

PropertyBuilder<TProperty>

An object that can be used to configure the property.

Remarks

When adding a new property, if a property with the same name exists in the entity class then it will be added to the model. If no property exists in the entity class, then a new shadow state property will be added. A shadow state 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.