IMutableProperty IMutableProperty Interface

Represents a scalar property of an entity.

This interface is used during model creation and allows the metadata to be modified. Once the model is built, IProperty represents a ready-only view of the same metadata.

Syntax

Declaration

public interface IMutableProperty : IProperty, IMutablePropertyBase, IPropertyBase, IMutableAnnotatable, IAnnotatablePublic Interface IMutableProperty
    Inherits IProperty, IMutablePropertyBase

Inherited Members

ClrType,
ClrType,
IsShadowProperty,
IsShadowProperty,
DeclaringType,
DeclaringType,
Name,
Name,
PropertyInfo,
PropertyInfo,
FieldInfo,
FieldInfo,
Item[String],
Item(String),
GetAnnotations(),
GetAnnotations(),
AddAnnotation(String, Object),
AddAnnotation(String, Object),
FindAnnotation(String),
FindAnnotation(String),
RemoveAnnotation(String)
RemoveAnnotation(String)

Properties summary

Gets the type that this property belongs to.

Gets or sets a value indicating whether this property is used as a concurrency token. When a property is configured as a concurrency token the value in the database will be checked when an instance of this entity type is updated or deleted during SaveChanges() to ensure it has not changed since the instance was retrieved from the database. If it has changed, an exception will be thrown and the changes will not be applied to the database.

Gets or sets a value indicating whether this property can contain null.

Gets or sets a value indicating whether or not this property can be modified after the entity is saved to the database. If true, an exception will be thrown if a new value is assigned to this property after the entity exists in the database.

Gets or sets a value indicating whether or not this property can be modified before the entity is saved to the database. If true, an exception will be thrown if a value is assigned to this property when it is in the Added state.

Gets or sets a value indicating whether or not the database will always generate a value for this property. If set to true, a value will always be read back from the database whenever the entity is saved regardless of the state of the property. If set to false, whenever a value is assigned to the property (or marked as modified) EF will attempt to save that value to the database rather than letting the database generate one.

Gets or sets a value indicating whether this property requires a ValueGenerator to generate values when new entities are added to the context.

Gets or sets a value indicating when a value for this property will be generated by the database. Even when the property is set to be generated by the database, EF may still attempt to save a specific value (rather than having one generated by the database) when the entity is added and a value is assigned, or the property is marked as modified for an existing entity. See IsStoreGeneratedAlways for more information.

Properties

  • DeclaringEntityType
    DeclaringEntityType

    Gets the type that this property belongs to.

    IMutableEntityType DeclaringEntityType { get; }ReadOnly Property DeclaringEntityType As IMutableEntityType

    Property Value

  • IsConcurrencyToken
    IsConcurrencyToken

    Gets or sets a value indicating whether this property is used as a concurrency token. When a property is configured as a concurrency token the value in the database will be checked when an instance of this entity type is updated or deleted during SaveChanges() to ensure it has not changed since the instance was retrieved from the database. If it has changed, an exception will be thrown and the changes will not be applied to the database.

    bool IsConcurrencyToken { get; set; }Property IsConcurrencyToken As Boolean

    Property Value

    • System.Boolean
      System.Boolean
  • IsNullable
    IsNullable

    Gets or sets a value indicating whether this property can contain null.

    bool IsNullable { get; set; }Property IsNullable As Boolean

    Property Value

    • System.Boolean
      System.Boolean
  • IsReadOnlyAfterSave
    IsReadOnlyAfterSave

    Gets or sets a value indicating whether or not this property can be modified after the entity is saved to the database. If true, an exception will be thrown if a new value is assigned to this property after the entity exists in the database.

    bool IsReadOnlyAfterSave { get; set; }Property IsReadOnlyAfterSave As Boolean

    Property Value

    • System.Boolean
      System.Boolean
  • IsReadOnlyBeforeSave
    IsReadOnlyBeforeSave

    Gets or sets a value indicating whether or not this property can be modified before the entity is saved to the database. If true, an exception will be thrown if a value is assigned to this property when it is in the Added state.

    bool IsReadOnlyBeforeSave { get; set; }Property IsReadOnlyBeforeSave As Boolean

    Property Value

    • System.Boolean
      System.Boolean
  • IsStoreGeneratedAlways
    IsStoreGeneratedAlways

    Gets or sets a value indicating whether or not the database will always generate a value for this property. If set to true, a value will always be read back from the database whenever the entity is saved regardless of the state of the property. If set to false, whenever a value is assigned to the property (or marked as modified) EF will attempt to save that value to the database rather than letting the database generate one.

    bool IsStoreGeneratedAlways { get; set; }Property IsStoreGeneratedAlways As Boolean

    Property Value

    • System.Boolean
      System.Boolean
  • RequiresValueGenerator
    RequiresValueGenerator

    Gets or sets a value indicating whether this property requires a ValueGenerator to generate values when new entities are added to the context.

    bool RequiresValueGenerator { get; set; }Property RequiresValueGenerator As Boolean

    Property Value

    • System.Boolean
      System.Boolean
  • ValueGenerated
    ValueGenerated

    Gets or sets a value indicating when a value for this property will be generated by the database. Even when the property is set to be generated by the database, EF may still attempt to save a specific value (rather than having one generated by the database) when the entity is added and a value is assigned, or the property is marked as modified for an existing entity. See IsStoreGeneratedAlways for more information.

    ValueGenerated ValueGenerated { get; set; }Property ValueGenerated As ValueGenerated

    Property Value

Details

Assembly

Microsoft.EntityFrameworkCore.dll