RuntimeProperty Class
Definition
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.
Represents a scalar property of an structural type.
public class RuntimeProperty : Microsoft.EntityFrameworkCore.Metadata.RuntimePropertyBase, Microsoft.EntityFrameworkCore.Metadata.IPropertytype RuntimeProperty = class
inherit RuntimePropertyBase
interface IProperty
interface IReadOnlyProperty
interface IReadOnlyPropertyBase
interface IReadOnlyAnnotatable
interface IPropertyBase
interface IAnnotatablePublic Class RuntimeProperty
Inherits RuntimePropertyBase
Implements IProperty- Inheritance
- Inheritance
- Implements
Remarks
See Modeling entity types and relationships for more information and examples.
Constructors
| RuntimeProperty(String, Type, PropertyInfo, FieldInfo, RuntimeEntityType, PropertyAccessMode, Boolean, Boolean, ValueGenerated, PropertySaveBehavior, PropertySaveBehavior, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>, Type, Func<IProperty,IEntityType,ValueGenerator>, ValueConverter, ValueComparer, ValueComparer, CoreTypeMapping) |
This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release. |
| RuntimeProperty(String, Type, PropertyInfo, FieldInfo, RuntimeEntityType, PropertyAccessMode, Boolean, Boolean, ValueGenerated, PropertySaveBehavior, PropertySaveBehavior, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>, Type, Func<IProperty,IEntityType,ValueGenerator>, ValueConverter, ValueComparer, ValueComparer, ValueComparer, CoreTypeMapping) |
This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release. |
| RuntimeProperty(String, Type, PropertyInfo, FieldInfo, RuntimeTypeBase, PropertyAccessMode, Boolean, Boolean, ValueGenerated, PropertySaveBehavior, PropertySaveBehavior, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>, Type, Func<IProperty,ITypeBase,ValueGenerator>, ValueConverter, ValueComparer, ValueComparer, ValueComparer, JsonValueReaderWriter, CoreTypeMapping, Object) |
This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release. |
Properties
| ClrType |
Gets the type of value that this property-like object holds. |
| DebugView |
This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release. |
| DeclaringEntityType |
Gets the type that this property belongs to. |
| DeclaringEntityType |
Gets the type that this property-like object belongs to. (Inherited from RuntimePropertyBase) |
| DeclaringType |
Gets the type that this property-like object belongs to. |
| DeclaringType |
Gets the type that this property-like object belongs to. (Inherited from RuntimePropertyBase) |
| ForeignKeys |
This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release. |
| Indexes |
This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release. |
| IsPrimitiveCollection |
This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release. |
| IsReadOnly |
Indicates whether the current object is read-only. (Inherited from AnnotatableBase) |
| Item[String] |
Gets the value annotation with the given name, returning |
| Item[String] |
Gets the value annotation with the given name, returning |
| Keys |
This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release. |
| Name |
Gets the name of this property-like object. (Inherited from RuntimePropertyBase) |
| PrimaryKey |
This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release. |
| Sentinel |
Gets the sentinel value that indicates that this property is not set. |
| Sentinel |
Gets the sentinel value that indicates that this property is not set. (Inherited from RuntimePropertyBase) |
| TypeMapping |
Gets or sets the type mapping for this property. |
Methods
| AddAnnotation(String, Annotation) |
Adds an annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from AnnotatableBase) |
| AddAnnotation(String, Object) |
Adds an annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from AnnotatableBase) |
| AddAnnotation(String, Object) |
Adds an annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from RuntimeAnnotatableBase) |
| AddAnnotations(IEnumerable<IAnnotation>) |
Adds annotations to this object. (Inherited from AnnotatableBase) |
| AddAnnotations(IEnumerable<IAnnotation>) |
Adds annotations to this object overriding any existing annotations with the same name. (Inherited from RuntimeAnnotatableBase) |
| AddAnnotations(IReadOnlyDictionary<String,Object>) |
Adds annotations to this object. (Inherited from AnnotatableBase) |
| AddAnnotations(IReadOnlyDictionary<String,Object>) |
Adds annotations to this object overriding any existing annotations with the same name. (Inherited from RuntimeAnnotatableBase) |
| AddRuntimeAnnotation(String, Annotation) |
Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from AnnotatableBase) |
| AddRuntimeAnnotation(String, Annotation) |
Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from RuntimeAnnotatableBase) |
| AddRuntimeAnnotation(String, Object) |
Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from AnnotatableBase) |
| AddRuntimeAnnotation(String, Object) |
Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from RuntimeAnnotatableBase) |
| AddRuntimeAnnotations(IEnumerable<Annotation>) |
Adds runtime annotations to this object. (Inherited from AnnotatableBase) |
| AddRuntimeAnnotations(IEnumerable<Annotation>) |
Adds runtime annotations to this object. (Inherited from RuntimeAnnotatableBase) |
| AddRuntimeAnnotations(IReadOnlyDictionary<String,Object>) |
Adds runtime annotations to this object. (Inherited from AnnotatableBase) |
| AddRuntimeAnnotations(IReadOnlyDictionary<String,Object>) |
Adds runtime annotations to this object. (Inherited from RuntimeAnnotatableBase) |
| CreateAnnotation(String, Object) |
Creates a new annotation. (Inherited from AnnotatableBase) |
| CreateAnnotation(String, Object) |
Creates a new annotation. (Inherited from RuntimeAnnotatableBase) |
| CreateRuntimeAnnotation(String, Object) |
Creates a new runtime annotation. (Inherited from AnnotatableBase) |
| CreateRuntimeAnnotation(String, Object) |
Creates a new runtime annotation. (Inherited from RuntimeAnnotatableBase) |
| EnsureMutable() |
Throws if the model is read-only. (Inherited from AnnotatableBase) |
| EnsureReadOnly() |
Throws if the model is not read-only. (Inherited from AnnotatableBase) |
| FindAnnotation(String) |
Gets the annotation with the given name, returning |
| FindAnnotation(String) |
Gets the annotation with the given name, returning |
| FindRuntimeAnnotation(String) |
Gets the runtime annotation with the given name, returning |
| FindRuntimeAnnotation(String) |
Gets the runtime annotation with the given name, returning |
| GetAnnotation(String) |
Gets the annotation with the given name, throwing if it does not exist. (Inherited from AnnotatableBase) |
| GetAnnotation(String) |
Gets the annotation with the given name, throwing if it does not exist. (Inherited from RuntimeAnnotatableBase) |
| GetAnnotations() |
Gets all annotations on the current object. (Inherited from AnnotatableBase) |
| GetElementType() |
Gets the configuration for elements of the primitive collection represented by this property. |
| GetJsonValueReaderWriter() |
Gets the JsonValueReaderWriter for this property, or |
| GetKeyValueComparer() |
Gets the ValueComparer to use with keys for this property. |
| GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg) |
Gets the value of the runtime annotation with the given name, adding it if one does not exist. (Inherited from AnnotatableBase) |
| GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg) |
Gets the value of the runtime annotation with the given name, adding it if one does not exist. (Inherited from RuntimeAnnotatableBase) |
| GetRuntimeAnnotations() |
Gets all runtime annotations on the current object. (Inherited from AnnotatableBase) |
| GetRuntimeAnnotations() |
Gets all runtime annotations on the current object. (Inherited from RuntimeAnnotatableBase) |
| GetValueComparer() |
Gets the ValueComparer for this property. |
| OnAnnotationSet(String, Annotation, Annotation) |
Called when an annotation was set or removed. (Inherited from AnnotatableBase) |
| RemoveAnnotation(String) |
Removes the given annotation from this object. (Inherited from AnnotatableBase) |
| RemoveAnnotation(String) |
Removes the given annotation from this object. (Inherited from RuntimeAnnotatableBase) |
| RemoveRuntimeAnnotation(String) |
Removes the given runtime annotation from this object. (Inherited from AnnotatableBase) |
| RemoveRuntimeAnnotation(String) |
Removes the given runtime annotation from this object. (Inherited from RuntimeAnnotatableBase) |
| SetAccessors(PropertyAccessors) |
This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release. (Inherited from RuntimePropertyBase) |
| SetAccessors<TProperty>(Func<InternalEntityEntry,TProperty>, Func<InternalEntityEntry, TProperty>, Func<InternalEntityEntry,TProperty>, Func<InternalEntityEntry, TProperty>, Func<ValueBuffer,Object>) |
This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release. (Inherited from RuntimePropertyBase) |
| SetAnnotation(String, Annotation, Annotation) |
Sets the annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists. (Inherited from AnnotatableBase) |
| SetAnnotation(String, Object) |
Sets the annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists. (Inherited from AnnotatableBase) |
| SetAnnotation(String, Object) |
Sets the annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists. (Inherited from RuntimeAnnotatableBase) |
| SetComparer(ValueComparer) |
This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release. |
| SetCurrentValueComparer(IComparer<IUpdateEntry>) |
This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release. (Inherited from RuntimePropertyBase) |
| SetElementType(Type, Boolean, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>, Type, ValueConverter, ValueComparer, JsonValueReaderWriter, CoreTypeMapping, Boolean) |
Sets the element type for this property. |
| SetGetter<TEntity,TStructuralType,TValue>(Func<TEntity,TValue>, Func<TEntity,Boolean>, Func<TStructuralType,TValue>, Func<TStructuralType,Boolean>) |
This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release. (Inherited from RuntimePropertyBase) |
| SetKeyComparer(ValueComparer) |
This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release. |
| SetMaterializationSetter<TEntity,TValue>(Action<TEntity,TValue>) |
This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release. (Inherited from RuntimePropertyBase) |
| SetPropertyIndexes(Int32, Int32, Int32, Int32, Int32) |
This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release. (Inherited from RuntimePropertyBase) |
| SetProviderValueComparer(ValueComparer) |
This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release. |
| SetRuntimeAnnotation(String, Annotation, Annotation) |
Sets the runtime annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists. (Inherited from AnnotatableBase) |
| SetRuntimeAnnotation(String, Annotation, Annotation) |
Sets the runtime annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists. (Inherited from RuntimeAnnotatableBase) |
| SetRuntimeAnnotation(String, Object) |
Sets the runtime annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists. (Inherited from AnnotatableBase) |
| SetRuntimeAnnotation(String, Object) |
Sets the runtime annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists. (Inherited from RuntimeAnnotatableBase) |
| SetSentinelFromProviderValue(Object) |
Sets the Sentinel value, converting from the provider type if needed. |
| SetSetter<TEntity,TValue>(Action<TEntity,TValue>) |
This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release. (Inherited from RuntimePropertyBase) |
| SetValueConverter(ValueConverter) |
This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release. |
| ToString() |
This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release. |
Explicit Interface Implementations
| IAnnotatable.AddRuntimeAnnotation(String, Object) |
Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from AnnotatableBase) |
| IAnnotatable.AddRuntimeAnnotation(String, Object) |
Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from RuntimeAnnotatableBase) |
| IAnnotatable.FindRuntimeAnnotation(String) |
Gets the runtime annotation with the given name, returning |
| IAnnotatable.FindRuntimeAnnotation(String) |
Gets the runtime annotation with the given name, returning |
| IAnnotatable.GetRuntimeAnnotations() |
Gets all the runtime annotations on the current object. (Inherited from AnnotatableBase) |
| IAnnotatable.GetRuntimeAnnotations() |
Gets all the runtime annotations on the current object. (Inherited from RuntimeAnnotatableBase) |
| IAnnotatable.RemoveRuntimeAnnotation(String) |
Removes the given runtime annotation from this object. (Inherited from AnnotatableBase) |
| IAnnotatable.RemoveRuntimeAnnotation(String) |
Removes the given runtime annotation from this object. (Inherited from RuntimeAnnotatableBase) |
| IAnnotatable.SetRuntimeAnnotation(String, Object) |
Sets the runtime annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists. (Inherited from AnnotatableBase) |
| IAnnotatable.SetRuntimeAnnotation(String, Object) |
Sets the runtime annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists. (Inherited from RuntimeAnnotatableBase) |
| IProperty.DeclaringEntityType |
Gets the entity type that this property belongs to. |
| IProperty.GetContainingForeignKeys() |
Gets all foreign keys that use this property (including composite foreign keys in which this property is included). |
| IProperty.GetContainingIndexes() |
Gets all indexes that use this property (including composite indexes in which this property is included). |
| IProperty.GetContainingKeys() |
Gets all primary or alternate keys that use this property (including composite keys in which this property is included). |
| IProperty.GetKeyValueComparer() |
Gets the ValueComparer to use with keys for this property. |
| IProperty.GetProviderValueComparer() |
Gets the ValueComparer to use for the provider values for this property. |
| IProperty.GetValueComparer() |
Gets the ValueComparer for this property. |
| IPropertyBase.GetCurrentValueComparer() |
Gets a IComparer<T> for comparing values in tracked IUpdateEntry entries. (Inherited from RuntimePropertyBase) |
| IPropertyBase.GetGetter() |
Gets a IClrPropertyGetter for reading the value of this property. (Inherited from RuntimePropertyBase) |
| IReadOnlyAnnotatable.FindAnnotation(String) |
Gets the annotation with the given name, returning |
| IReadOnlyAnnotatable.FindAnnotation(String) |
Gets the annotation with the given name, returning |
| IReadOnlyAnnotatable.GetAnnotations() |
Gets all annotations on the current object. (Inherited from AnnotatableBase) |
| IReadOnlyAnnotatable.GetAnnotations() |
Gets all annotations on the current object. (Inherited from RuntimeAnnotatableBase) |
| IReadOnlyAnnotatable.Item[String] |
Gets the value of the annotation with the given name, returning |
| IReadOnlyAnnotatable.Item[String] |
Gets the value of the annotation with the given name, returning |
| IReadOnlyProperty.DeclaringEntityType |
Gets the entity type that this property belongs to. |
| IReadOnlyProperty.FindContainingPrimaryKey() |
Gets the primary key that uses this property (including a composite primary key in which this property is included). |
| IReadOnlyProperty.FindTypeMapping() |
Returns the type mapping for this property. |
| IReadOnlyProperty.GetAfterSaveBehavior() |
Gets a value indicating whether or not this property can be modified after the entity is saved to the database. |
| IReadOnlyProperty.GetBeforeSaveBehavior() |
Gets a value indicating whether or not this property can be modified before the entity is saved to the database. |
| IReadOnlyProperty.GetContainingForeignKeys() |
Gets all foreign keys that use this property (including composite foreign keys in which this property is included). |
| IReadOnlyProperty.GetContainingIndexes() |
Gets all indexes that use this property (including composite indexes in which this property is included). |
| IReadOnlyProperty.GetContainingKeys() |
Gets all primary or alternate keys that use this property (including composite keys in which this property is included). |
| IReadOnlyProperty.GetElementType() |
Gets the configuration for elements of the primitive collection represented by this property. |
| IReadOnlyProperty.GetKeyValueComparer() |
Gets the ValueComparer to use with keys for this property. |
| IReadOnlyProperty.GetMaxLength() |
Gets the maximum length of data that is allowed in this property. For example, if the property is a String then this is the maximum number of characters. |
| IReadOnlyProperty.GetPrecision() |
Gets the precision of data that is allowed in this property. For example, if the property is a Decimal then this is the maximum number of digits. |
| IReadOnlyProperty.GetProviderClrType() |
Gets the type that the property value will be converted to before being sent to the database provider. |
| IReadOnlyProperty.GetProviderValueComparer() |
Gets the ValueComparer to use for the provider values for this property. |
| IReadOnlyProperty.GetScale() |
Gets the scale of data that is allowed in this property. For example, if the property is a Decimal then this is the maximum number of decimal places. |
| IReadOnlyProperty.GetValueComparer() |
Gets the ValueComparer for this property. |
| IReadOnlyProperty.GetValueConverter() |
Gets the custom ValueConverter set for this property. |
| IReadOnlyProperty.GetValueGeneratorFactory() |
Gets the factory that has been set to generate values for this property, if any. |
| IReadOnlyProperty.IsConcurrencyToken |
Gets 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. |
| IReadOnlyProperty.IsForeignKey() |
Gets a value indicating whether this property is used as a foreign key (or part of a composite foreign key). |
| IReadOnlyProperty.IsIndex() |
Gets a value indicating whether this property is used as an index (or part of a composite index). |
| IReadOnlyProperty.IsKey() |
Gets a value indicating whether this property is used as the primary key or alternate key (or part of a composite primary or alternate key). |
| IReadOnlyProperty.IsNullable |
Gets a value indicating whether this property can contain |
| IReadOnlyProperty.IsUnicode() |
Gets a value indicating whether or not the property can persist Unicode characters. |
| IReadOnlyProperty.ValueGenerated |
Gets 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 GetBeforeSaveBehavior() and GetAfterSaveBehavior() for more information and examples. |
| IReadOnlyPropertyBase.ClrType |
Gets the type of value that this property-like object holds. (Inherited from RuntimePropertyBase) |
| IReadOnlyPropertyBase.DeclaringType |
Gets the type that this property-like object belongs to. (Inherited from RuntimePropertyBase) |
| IReadOnlyPropertyBase.FieldInfo |
Gets the FieldInfo for the underlying CLR field for this property-like object.
This may be |
| IReadOnlyPropertyBase.GetPropertyAccessMode() |
Gets the PropertyAccessMode being used for this property-like object. (Inherited from RuntimePropertyBase) |
| IReadOnlyPropertyBase.PropertyInfo |
Gets the PropertyInfo for the underlying CLR property for this property-like object.
This may be |
| IRuntimePropertyBase.Accessors | (Inherited from RuntimePropertyBase) |
| IRuntimePropertyBase.GetSetter() | (Inherited from RuntimePropertyBase) |
| IRuntimePropertyBase.MaterializationSetter | (Inherited from RuntimePropertyBase) |
| IRuntimePropertyBase.PropertyIndexes | (Inherited from RuntimePropertyBase) |
| IRuntimePropertyBase.Setter | (Inherited from RuntimePropertyBase) |
Extension Methods
| GetJsonPropertyName(IProperty) |
Returns the property name that the property is mapped to when targeting Cosmos. |
| GetJsonPropertyName(IReadOnlyProperty) |
Returns the property name that the property is mapped to when targeting Cosmos. |
| GetPropertyName(IProperty) |
Returns the property name used when targeting Cosmos. |
| GetVectorType(IReadOnlyProperty) |
Returns the definition of the vector stored in this property. |
| AnnotationsToDebugString(IAnnotatable, Int32) |
Gets the debug string for all annotations declared on the object. |
| GetCurrentValueComparer(IPropertyBase) |
Gets a IComparer<T> for comparing values in tracked IUpdateEntry entries. |
| GetGetter(IPropertyBase) |
Gets a IClrPropertyGetter for reading the value of this property. Note that it is an error to call this method for a shadow property (IsShadowProperty(IPropertyBase)) since such a property has no associated MemberInfo. |
| GetIndex(IPropertyBase) |
Gets the property index for this property. |
| GetMemberInfo(IPropertyBase, Boolean, Boolean) |
Gets the PropertyInfo or FieldInfo that should be used to get or set a value for the given property. Note that it is an error to call this method for a shadow property (IsShadowProperty(IPropertyBase)) since such a property has no associated MemberInfo. |
| IsIndexerProperty(IPropertyBase) |
Gets a value indicating whether this is an indexer property. An indexer property is one that is accessed through an indexer on the entity class. |
| IsShadowProperty(IPropertyBase) |
Obsolete.
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. |
| CreateKeyEqualityComparer<TProperty>(IProperty) |
Creates an IEqualityComparer<T> for values of the given property type. |
| FindContainingPrimaryKey(IProperty) |
Gets the primary key that uses this property (including a composite primary key in which this property is included). |
| FindFirstPrincipal(IProperty) |
Finds the first principal property that the given property is constrained by if the given property is part of a foreign key. |
| FindMapping(IProperty) |
Obsolete.
Returns the CoreTypeMapping for the given property. |
| FindPrincipals(IProperty) |
Obsolete.
Finds the list of principal properties including the given property that the given property is constrained by if the given property is part of a foreign key. |
| FindTypeMapping(IProperty) |
Returns the CoreTypeMapping for the given property. |
| GetAfterSaveBehavior(IProperty) |
Obsolete.
Gets a value indicating whether or not this property can be modified after the entity is saved to the database. If Throw, then an exception will be thrown if a new value is assigned to this property after the entity exists in the database. If Ignore, then any modification to the property value of an entity that already exists in the database will be ignored. |
| GetBeforeSaveBehavior(IProperty) |
Obsolete.
Gets a value indicating whether or not this property can be modified before the entity is saved to the database. If Throw, then an exception will be thrown if a value is assigned to this property when it is in the Added state. If Ignore, then any value set will be ignored when it is in the Added state. |
| GetPrecision(IProperty) |
Gets the precision of data that is allowed in this property. For example, if the property is a Decimal then this is the maximum number of digits. |
| GetScale(IProperty) |
Gets the scale of data that is allowed in this property. For example, if the property is a Decimal then this is the maximum number of decimal places. |
| GetStructuralValueComparer(IProperty) |
Obsolete.
Gets the ValueComparer to use for structural copies for this property, or |
| GetTypeMapping(IProperty) |
Returns the CoreTypeMapping for the given property from a finalized model. |
| GetValueConverter(IProperty) |
Obsolete.
Gets the custom ValueConverter set for this property. |
| GetValueGeneratorFactory(IProperty) |
Obsolete.
Gets the factory that has been set to generate values for this property, if any. |
| IsForeignKey(IProperty) |
Obsolete.
Gets a value indicating whether this property is used as a foreign key (or part of a composite foreign key). |
| IsIndex(IProperty) |
Obsolete.
Gets a value indicating whether this property is used as an index (or part of a composite index). |
| IsKey(IProperty) |
Obsolete.
Gets a value indicating whether this property is used as the primary key or alternate key (or part of a composite primary or alternate key). |
| IsPrimaryKey(IProperty) |
Obsolete.
Gets a value indicating whether this property is used as the primary key (or part of a composite primary key). |
| IsUniqueIndex(IProperty) |
Obsolete.
Gets a value indicating whether this property is used as a unique index (or part of a unique composite index). |
| ToDebugString(IProperty, MetadataDebugStringOptions, Int32) |
Creates a human-readable representation of the given metadata. Warning: Do not rely on the format of the returned string. It is designed for debugging only and may change arbitrarily between releases. |
| FindColumn(IProperty, StoreObjectIdentifier) |
Returns the column corresponding to this property if it's mapped to the given table-like store object. |
| FindOverrides(IProperty, StoreObjectIdentifier) |
Returns the property facet overrides for a particular table-like store object. This method is typically used by database providers (and other extensions). It is generally not used in application code. |
| FindOverrides(IReadOnlyProperty, StoreObjectIdentifier) |
Returns the property facet overrides for a particular table-like store object. This method is typically used by database providers (and other extensions). It is generally not used in application code. |
| FindRelationalMapping(IProperty) |
Obsolete.
Returns the RelationalTypeMapping for the given property on a finalized model. |
| FindRelationalTypeMapping(IProperty, StoreObjectIdentifier) |
Returns the RelationalTypeMapping for the given property on a finalized model. |
| FindRelationalTypeMapping(IProperty) |
Returns the RelationalTypeMapping for the given property on a finalized model. |
| FindRelationalTypeMapping(IReadOnlyProperty, StoreObjectIdentifier) |
Returns the RelationalTypeMapping for the given property on a finalized model. |
| FindRelationalTypeMapping(IReadOnlyProperty) |
Returns the RelationalTypeMapping for the given property on a finalized model. |
| FindSharedStoreObjectRootProperty(IProperty, StoreObjectIdentifier) |
Finds the first IProperty that is mapped to the same column in a shared table-like object. This method is typically used by database providers (and other extensions). It is generally not used in application code. |
| FindSharedStoreObjectRootProperty(IReadOnlyProperty, StoreObjectIdentifier) |
Finds the first IProperty that is mapped to the same column in a shared table-like object. This method is typically used by database providers (and other extensions). It is generally not used in application code. |
| FindSharedTableRootPrimaryKeyProperty(IProperty) |
Finds the IProperty that represents the same primary key property as the given property, but potentially in a shared root table. This type is typically used by database providers (and other extensions). It is generally not used in application code. |
| GetCollation(IProperty, StoreObjectIdentifier) |
Returns the collation to be used for the column. |
| GetCollation(IProperty) |
Returns the collation to be used for the column. |
| GetCollation(IReadOnlyProperty, StoreObjectIdentifier) |
Returns the collation to be used for the column. |
| GetCollation(IReadOnlyProperty) |
Returns the collation to be used for the column. |
| GetColumnBaseName(IProperty) |
Returns the base name of the column to which the property would be mapped. |
| GetColumnBaseName(IReadOnlyProperty) |
Obsolete.
Returns the base name of the column to which the property would be mapped. |
| GetColumnName(IProperty, StoreObjectIdentifier) |
Returns the name of the column to which the property is mapped for a particular table. |
| GetColumnName(IProperty) |
Obsolete.
Returns the name of the table column to which the property is mapped. |
| GetColumnName(IReadOnlyProperty, StoreObjectIdentifier) |
Returns the name of the column to which the property is mapped for a particular table. |
| GetColumnName(IReadOnlyProperty) |
Returns the name of the column to which the property would be mapped. |
| GetColumnOrder(IReadOnlyProperty, StoreObjectIdentifier) |
Returns the order of the column this property is mapped to for a particular table. |
| GetColumnOrder(IReadOnlyProperty) |
Returns the order of the column this property is mapped to. |
| GetColumnType(IProperty, StoreObjectIdentifier) |
Returns the database type of the column to which the property is mapped. |
| GetColumnType(IProperty) |
Returns the database type of the column to which the property is mapped. |
| GetColumnType(IReadOnlyProperty, StoreObjectIdentifier) |
Returns the database type of the column to which the property is mapped, or |
| GetColumnType(IReadOnlyProperty) |
Returns the database type of the column to which the property is mapped, or |
| GetComment(IProperty, StoreObjectIdentifier) |
Returns the comment for the column this property is mapped to. |
| GetComment(IProperty) |
Returns the comment for the column this property is mapped to. |
| GetComment(IReadOnlyProperty, StoreObjectIdentifier) |
Returns the comment for the column this property is mapped to. |
| GetComment(IReadOnlyProperty) |
Returns the comment for the column this property is mapped to. |
| GetComputedColumnSql(IProperty, StoreObjectIdentifier) |
Returns the SQL expression that is used as the computed value for the column this property is mapped to. |
| GetComputedColumnSql(IProperty) |
Returns the SQL expression that is used as the computed value for the column this property is mapped to. |
| GetComputedColumnSql(IReadOnlyProperty, StoreObjectIdentifier) |
Returns the SQL expression that is used as the computed value for the column this property is mapped to. |
| GetComputedColumnSql(IReadOnlyProperty) |
Returns the SQL expression that is used as the computed value for the column this property is mapped to. |
| GetDefaultColumnBaseName(IProperty) |
Returns the default base name of the column to which the property would be mapped |
| GetDefaultColumnBaseName(IReadOnlyProperty) |
Obsolete.
Returns the default base name of the column to which the property would be mapped |
| GetDefaultColumnMappings(IProperty) |
Returns the default columns to which the property would be mapped. |
| GetDefaultColumnName(IProperty, StoreObjectIdentifier) |
Returns the default column name to which the property would be mapped. |
| GetDefaultColumnName(IProperty) |
Obsolete.
Returns the default table column name to which the property would be mapped. |
| GetDefaultColumnName(IReadOnlyProperty, StoreObjectIdentifier) |
Returns the default column name to which the property would be mapped. |
| GetDefaultColumnName(IReadOnlyProperty) |
Returns the default base name of the column to which the property would be mapped |
| GetDefaultValue(IProperty, StoreObjectIdentifier) |
Returns the object that is used as the default value for the column this property is mapped to. |
| GetDefaultValue(IProperty) |
Returns the object that is used as the default value for the column this property is mapped to. |
| GetDefaultValue(IReadOnlyProperty, StoreObjectIdentifier) |
Returns the object that is used as the default value for the column this property is mapped to. |
| GetDefaultValue(IReadOnlyProperty) |
Returns the object that is used as the default value for the column this property is mapped to. |
| GetDefaultValueSql(IProperty, StoreObjectIdentifier) |
Returns the SQL expression that is used as the default value for the column this property is mapped to. |
| GetDefaultValueSql(IProperty) |
Returns the SQL expression that is used as the default value for the column this property is mapped to. |
| GetDefaultValueSql(IReadOnlyProperty, StoreObjectIdentifier) |
Returns the SQL expression that is used as the default value for the column this property is mapped to. |
| GetDefaultValueSql(IReadOnlyProperty) |
Returns the SQL expression that is used as the default value for the column this property is mapped to. |
| GetDeleteStoredProcedureParameterMappings(IProperty) |
Returns the delete stored procedure parameters to which the property is mapped. |
| GetFunctionColumnMappings(IProperty) |
Returns the function columns to which the property is mapped. |
| GetInsertStoredProcedureParameterMappings(IProperty) |
Returns the insert stored procedure parameters to which the property is mapped. |
| GetInsertStoredProcedureResultColumnMappings(IProperty) |
Returns the insert stored procedure result columns to which the property is mapped. |
| GetIsStored(IProperty, StoreObjectIdentifier) |
Gets whether the value of the computed column this property is mapped to is stored in the database, or calculated when it is read. |
| GetIsStored(IProperty) |
Gets whether the value of the computed column this property is mapped to is stored in the database, or calculated when it is read. |
| GetIsStored(IReadOnlyProperty, StoreObjectIdentifier) |
Gets whether the value of the computed column this property is mapped to is stored in the database, or calculated when it is read. |
| GetIsStored(IReadOnlyProperty) |
Gets whether the value of the computed column this property is mapped to is stored in the database, or calculated when it is read. |
| GetJsonPropertyName(IReadOnlyProperty) |
Gets the value of JSON property name used for the given property of an entity mapped to a JSON column. |
| GetMappedStoreObjects(IReadOnlyProperty, StoreObjectType) |
Returns the table-like store objects to which this property is mapped. This method is typically used by database providers (and other extensions). It is generally not used in application code. |
| GetMaxLength(IProperty, StoreObjectIdentifier) |
Gets the maximum length of data that is allowed in this property. For example, if the property is a String then this is the maximum number of characters. |
| GetMaxLength(IReadOnlyProperty, StoreObjectIdentifier) |
Gets the maximum length of data that is allowed in this property. For example, if the property is a String then this is the maximum number of characters. |
| GetOverrides(IProperty) |
Returns all the property facet overrides. This method is typically used by database providers (and other extensions). It is generally not used in application code. |
| GetOverrides(IReadOnlyProperty) |
Returns all the property facet overrides. This method is typically used by database providers (and other extensions). It is generally not used in application code. |
| GetPrecision(IProperty, StoreObjectIdentifier) |
Gets the precision of data that is allowed in this property. For example, if the property is a Decimal then this is the maximum number of digits. |
| GetPrecision(IReadOnlyProperty, StoreObjectIdentifier) |
Gets the precision of data that is allowed in this property. For example, if the property is a Decimal then this is the maximum number of digits. |
| GetReaderFieldValue(IProperty, RelationalDataReader, Int32, Boolean) |
Reads a value for this property from the given |
| GetRelationalTypeMapping(IProperty) |
Returns the RelationalTypeMapping for the given property on a finalized model. |
| GetRelationalTypeMapping(IReadOnlyProperty) |
Returns the RelationalTypeMapping for the given property on a finalized model. |
| GetScale(IProperty, StoreObjectIdentifier) |
Gets the scale of data that is allowed in this property. For example, if the property is a Decimal then this is the maximum number of decimal places. |
| GetScale(IReadOnlyProperty, StoreObjectIdentifier) |
Gets the scale of data that is allowed in this property. For example, if the property is a Decimal then this is the maximum number of decimal places. |
| GetSqlQueryColumnMappings(IProperty) |
Returns the SQL query columns to which the property is mapped. |
| GetTableColumnMappings(IProperty) |
Returns the table columns to which the property is mapped. |
| GetUpdateStoredProcedureParameterMappings(IProperty) |
Returns the update stored procedure parameters to which the property is mapped. |
| GetUpdateStoredProcedureResultColumnMappings(IProperty) |
Returns the update stored procedure result columns to which the property is mapped. |
| GetViewColumnMappings(IProperty) |
Returns the view columns to which the property is mapped. |
| IsColumnNullable(IProperty, StoreObjectIdentifier) |
Checks whether the column mapped to the given IProperty will be nullable when created in the database. This depends on the property itself and also how it is mapped. For example, derived non-nullable properties in a TPH type hierarchy will be mapped to nullable columns. As well as properties on optional types sharing the same table. |
| IsColumnNullable(IProperty) |
Checks whether the column mapped to the given IProperty will be nullable when created in the database. This depends on the property itself and also how it is mapped. For example, derived non-nullable properties in a TPH type hierarchy will be mapped to nullable columns. As well as properties on optional types sharing the same table. |
| IsColumnNullable(IReadOnlyProperty, StoreObjectIdentifier) |
Checks whether the column mapped to the given property will be nullable when created in the database. |
| IsColumnNullable(IReadOnlyProperty) |
Checks whether the column mapped to the given IProperty will be nullable when created in the database. |
| IsFixedLength(IProperty, StoreObjectIdentifier) |
Returns a flag indicating if the property as capable of storing only fixed-length data, such as strings. |
| IsFixedLength(IProperty) |
Returns a flag indicating if the property as capable of storing only fixed-length data, such as strings. |
| IsFixedLength(IReadOnlyProperty, StoreObjectIdentifier) |
Returns a flag indicating whether the property is capable of storing only fixed-length data, such as strings. |
| IsFixedLength(IReadOnlyProperty) |
Returns a flag indicating whether the property is capable of storing only fixed-length data, such as strings. |
| IsUnicode(IProperty, StoreObjectIdentifier) |
Gets a value indicating whether or not the property can persist Unicode characters. |
| IsUnicode(IReadOnlyProperty, StoreObjectIdentifier) |
Gets a value indicating whether or not the property can persist Unicode characters. |
| TryGetDefaultValue(IReadOnlyProperty, StoreObjectIdentifier, Object) |
Returns the object that is used as the default value for the column this property is mapped to. |
| TryGetDefaultValue(IReadOnlyProperty, Object) |
Returns the object that is used as the default value for the column this property is mapped to. |
| GetDataAnnotations(IProperty, IAnnotationCodeGenerator) |
Gets the data annotations to configure a property. |
| GetFluentApiCalls(IProperty, IAnnotationCodeGenerator) |
Gets the fluent API calls to configure a property. |
| GetGeometricDimension(IProperty) |
Returns the dimension to use when creating a column for this property. |
| GetSrid(IProperty, StoreObjectIdentifier) |
Returns the SRID to use when creating a column for this property. |
| GetSrid(IProperty) |
Returns the SRID to use when creating a column for this property. |
| GetSrid(IReadOnlyProperty, StoreObjectIdentifier) |
Returns the SRID to use when creating a column for this property. |
| GetSrid(IReadOnlyProperty) |
Returns the SRID to use when creating a column for this property. |
| FindHiLoSequence(IProperty, StoreObjectIdentifier) |
Finds the ISequence in the model to use for the hi-lo pattern. |
| FindHiLoSequence(IProperty) |
Finds the ISequence in the model to use for the hi-lo pattern. |
| FindHiLoSequence(IReadOnlyProperty, StoreObjectIdentifier) |
Finds the ISequence in the model to use for the hi-lo pattern. |
| FindHiLoSequence(IReadOnlyProperty) |
Finds the ISequence in the model to use for the hi-lo pattern. |
| FindSequence(IProperty, StoreObjectIdentifier) |
Finds the ISequence in the model to use for the key value generation pattern. |
| FindSequence(IProperty) |
Finds the ISequence in the model to use for the key value generation pattern. |
| FindSequence(IReadOnlyProperty, StoreObjectIdentifier) |
Finds the ISequence in the model to use for the key value generation pattern. |
| FindSequence(IReadOnlyProperty) |
Finds the ISequence in the model to use for the key value generation pattern. |
| GetHiLoSequenceName(IProperty, StoreObjectIdentifier) |
Returns the name to use for the hi-lo sequence. |
| GetHiLoSequenceName(IProperty) |
Returns the name to use for the hi-lo sequence. |
| GetHiLoSequenceName(IReadOnlyProperty, StoreObjectIdentifier) |
Returns the name to use for the hi-lo sequence. |
| GetHiLoSequenceName(IReadOnlyProperty) |
Returns the name to use for the hi-lo sequence. |
| GetHiLoSequenceSchema(IProperty, StoreObjectIdentifier) |
Returns the schema to use for the hi-lo sequence. |
| GetHiLoSequenceSchema(IProperty) |
Returns the schema to use for the hi-lo sequence. |
| GetHiLoSequenceSchema(IReadOnlyProperty, StoreObjectIdentifier) |
Returns the schema to use for the hi-lo sequence. |
| GetHiLoSequenceSchema(IReadOnlyProperty) |
Returns the schema to use for the hi-lo sequence. |
| GetIdentityIncrement(IProperty, StoreObjectIdentifier) |
Returns the identity increment. |
| GetIdentityIncrement(IProperty) |
Returns the identity increment. |
| GetIdentityIncrement(IReadOnlyProperty, StoreObjectIdentifier) |
Returns the identity increment. |
| GetIdentityIncrement(IReadOnlyProperty) |
Returns the identity increment. |
| GetIdentitySeed(IProperty, StoreObjectIdentifier) |
Returns the identity seed. |
| GetIdentitySeed(IProperty) |
Returns the identity seed. |
| GetIdentitySeed(IReadOnlyProperty, StoreObjectIdentifier) |
Returns the identity seed. |
| GetIdentitySeed(IReadOnlyProperty) |
Returns the identity seed. |
| GetSequenceName(IReadOnlyProperty, StoreObjectIdentifier) |
Returns the name to use for the key value generation sequence. |
| GetSequenceName(IReadOnlyProperty) |
Returns the name to use for the key value generation sequence. |
| GetSequenceSchema(IReadOnlyProperty, StoreObjectIdentifier) |
Returns the schema to use for the key value generation sequence. |
| GetSequenceSchema(IReadOnlyProperty) |
Returns the schema to use for the key value generation sequence. |
| GetValueGenerationStrategy(IProperty, StoreObjectIdentifier) |
Returns the SqlServerValueGenerationStrategy to use for the property. If no strategy is set for the property, then the strategy to use will be taken from the IModel. |
| GetValueGenerationStrategy(IProperty) |
Returns the SqlServerValueGenerationStrategy to use for the property. If no strategy is set for the property, then the strategy to use will be taken from the IModel. |
| GetValueGenerationStrategy(IReadOnlyProperty, StoreObjectIdentifier) |
Returns the SqlServerValueGenerationStrategy to use for the property. |
| GetValueGenerationStrategy(IReadOnlyProperty) |
Returns the SqlServerValueGenerationStrategy to use for the property. |
| IsSparse(IReadOnlyProperty, StoreObjectIdentifier) |
Returns a value indicating whether the property's column is sparse. |
| IsSparse(IReadOnlyProperty) |
Returns a value indicating whether the property's column is sparse. |
Applies to
Entity Framework