IMutableProperty IMutableProperty Interface

Definition

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.

public interface IMutableProperty : IProperty, IMutablePropertyBase, IPropertyBase, IMutableAnnotatable, IAnnotatable
Public Interface IMutableProperty
    Inherits IProperty, IMutablePropertyBase

Properties

ClrType ClrType

Gets the type of value that this property holds.

(Inherited from IProperty)

DeclaringEntityType DeclaringEntityType

Gets the type that this property belongs to.

IMutableEntityType DeclaringEntityType { get; }
ReadOnly Property DeclaringEntityType As IMutableEntityType

DeclaringType DeclaringType

Gets the type that this property belongs to.

(Inherited from IMutablePropertyBase)

FieldInfo FieldInfo

Gets the FieldInfo for the underlying CLR field that this object represents. This may be null for shadow properties or if the backing field for the property is not known.

(Inherited from IPropertyBase)

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
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
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
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
Value
System.Boolean System.Boolean

IsShadowProperty 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 IProperty)

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
Value
System.Boolean System.Boolean

Item[String] Item(String)

Gets or sets the value of the annotation with the given name.

(Inherited from IMutableAnnotatable)

Name Name

Gets the name of the property.

(Inherited from IPropertyBase)

PropertyInfo PropertyInfo

Gets the PropertyInfo for the underlying CLR property that this object represents. This may be null for shadow properties or properties mapped directly to fields.

(Inherited from IPropertyBase)

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
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

Methods

AddAnnotation(String, Object) AddAnnotation(String, Object)

Adds an annotation to this object. Throws if an annotation with the specified name already exists.

(Inherited from IMutableAnnotatable)

FindAnnotation(String) FindAnnotation(String)

Gets the annotation with the given name, returning null if it does not exist.

(Inherited from IMutableAnnotatable)

GetAnnotations() GetAnnotations()

Gets all annotations on the current object.

(Inherited from IMutableAnnotatable)

RemoveAnnotation(String) RemoveAnnotation(String)

Removes the given annotation from this object.

(Inherited from IMutableAnnotatable)