IConventionPropertyBase Interface
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.
Base type for navigation and scalar properties.
public interface IConventionPropertyBase : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IPropertyBasepublic interface IConventionPropertyBase : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyPropertyBasetype IConventionPropertyBase = interface
interface IPropertyBase
interface IAnnotatable
interface IConventionAnnotatabletype IConventionPropertyBase = interface
interface IReadOnlyPropertyBase
interface IReadOnlyAnnotatable
interface IConventionAnnotatablePublic Interface IConventionPropertyBase
Implements IConventionAnnotatable, IPropertyBasePublic Interface IConventionPropertyBase
Implements IConventionAnnotatable, IReadOnlyPropertyBase- Derived
- Implements
Remarks
This interface is used during model creation and allows the metadata to be modified. Once the model is built, IReadOnlyPropertyBase represents a read-only view of the same metadata.
See Model building conventions for more information and examples.
Properties
| Builder |
Gets the builder that can be used to configure this object. (Inherited from IConventionAnnotatable) |
| ClrType |
Gets the type of value that this property-like object holds. (Inherited from IReadOnlyPropertyBase) |
| DeclaringEntityType |
Obsolete.
Gets the entity type that this property belongs to. (Inherited from IPropertyBase) |
| DeclaringType |
Gets the type that this property belongs to. |
| FieldInfo |
Gets the FieldInfo for the underlying CLR field for this property-like object.
This may be |
| IsInModel |
Indicates whether this object is in a model, i.e. hasn't been removed from one. (Inherited from IConventionAnnotatable) |
| Item[String] |
Gets the value of the annotation with the given name, returning |
| Name |
Gets the name of this property-like object. (Inherited from IReadOnlyPropertyBase) |
| PropertyInfo |
Gets the PropertyInfo for the underlying CLR property for this property-like object.
This may be |
| Sentinel |
Gets the sentinel value that indicates that this property is not set. (Inherited from IReadOnlyPropertyBase) |
Methods
| AddAnnotation(String, Object, Boolean) |
Adds an annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from IConventionAnnotatable) |
| AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean) |
Adds annotations to an object. (Inherited from IConventionAnnotatable) |
| AddRuntimeAnnotation(String, Object) |
Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from IAnnotatable) |
| AnnotationsToDebugString(Int32) |
Gets the debug string for all annotations declared on the object. (Inherited from IReadOnlyAnnotatable) |
| FindAnnotation(String) |
Gets the annotation with the given name, returning |
| FindRuntimeAnnotation(String) |
Gets the runtime annotation with the given name, returning |
| FindRuntimeAnnotationValue(String) |
Gets the value of 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 IReadOnlyAnnotatable) |
| GetAnnotations() |
Gets all annotations on the current object. (Inherited from IReadOnlyAnnotatable) |
| GetConfigurationSource() |
Returns the configuration source for this property. |
| GetCurrentValueComparer() |
Gets a IComparer<T> for comparing values in tracked IUpdateEntry entries. (Inherited from IPropertyBase) |
| GetFieldInfoConfigurationSource() |
Returns the configuration source for FieldInfo. |
| GetFieldName() |
Gets the name of the backing field for this property, or |
| GetGetter() |
Gets a IClrPropertyGetter for reading the value of this property. (Inherited from IPropertyBase) |
| GetIndex() |
Gets the property index for this property. (Inherited from IPropertyBase) |
| GetMemberInfo(Boolean, Boolean) |
Gets the PropertyInfo or FieldInfo that should be used to get or set a value for the given property. (Inherited from IPropertyBase) |
| 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 IAnnotatable) |
| GetPropertyAccessMode() |
Gets the PropertyAccessMode being used for this property-like object. (Inherited from IReadOnlyPropertyBase) |
| GetPropertyAccessModeConfigurationSource() |
Returns the configuration source for GetPropertyAccessMode(). |
| GetRuntimeAnnotations() |
Gets all the runtime annotations on the current object. (Inherited from IAnnotatable) |
| IsIndexerProperty() |
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. (Inherited from IReadOnlyPropertyBase) |
| 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 IReadOnlyPropertyBase) |
| RemoveAnnotation(String) |
Removes the annotation with the given name from this object. (Inherited from IConventionAnnotatable) |
| RemoveRuntimeAnnotation(String) |
Removes the given runtime annotation from this object. (Inherited from IAnnotatable) |
| SetAnnotation(String, Object, Boolean) |
Sets the annotation stored under the given name. Overwrites the existing annotation if an annotation with the specified name already exists. (Inherited from IConventionAnnotatable) |
| SetField(FieldInfo, Boolean) |
Obsolete.
Sets the FieldInfo for the underlying CLR field that this property should use. By default, the backing field, if one is found or has been specified, is used when new objects are constructed, typically when entities are queried from the database. Properties are used for all other accesses. This can be changed by calling SetPropertyAccessMode(Nullable<PropertyAccessMode>, Boolean). |
| SetField(String, Boolean) |
Sets the underlying CLR field that this property should use.
This may be |
| SetFieldInfo(FieldInfo, Boolean) |
Sets the FieldInfo for the underlying CLR field that this property should use. |
| SetOrRemoveAnnotation(String, Object, Boolean) |
Sets the annotation stored under the given name. Overwrites the existing annotation if an
annotation with the specified name already exists. Removes the existing annotation if |
| SetPropertyAccessMode(Nullable<PropertyAccessMode>, Boolean) |
Sets the PropertyAccessMode to use for this property. |
| 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 IAnnotatable) |
Extension Methods
| AddAnnotations(IConventionAnnotatable, IEnumerable<IConventionAnnotation>, Boolean) |
Adds annotations to an object. |
| GetAnnotation(IConventionAnnotatable, String) |
Gets the annotation with the given name, throwing if it does not exist. |
| SetOrRemoveAnnotation(IConventionAnnotatable, String, Object, Boolean) |
Sets the annotation stored under the given name. Overwrites the existing annotation if an
annotation with the specified name already exists. Removes the existing annotation if |
| GetPropertyAccessModeConfigurationSource(IConventionPropertyBase) |
Returns the configuration source for GetPropertyAccessMode(). |
| SetField(IConventionPropertyBase, String, Boolean) |
Sets the underlying CLR field that this property should use.
This may be Backing fields are normally found by convention as described here: http://go.microsoft.com/fwlink/?LinkId=723277. This method is useful for setting backing fields explicitly in cases where the correct field is not found by convention. By default, the backing field, if one is found or has been specified, is used when new objects are constructed, typically when entities are queried from the database. Properties are used for all other accesses. This can be changed by calling SetPropertyAccessMode(IConventionPropertyBase, Nullable<PropertyAccessMode>, Boolean). |
| SetPropertyAccessMode(IConventionPropertyBase, Nullable<PropertyAccessMode>, Boolean) |
Sets the PropertyAccessMode to use for this property. |
| AnnotationsToDebugString(IAnnotatable, Int32) |
Gets the debug string for all annotations declared on the object. |
| GetAnnotation(IAnnotatable, String) |
Gets the annotation with the given name, throwing if it does not exist. |
| GetCurrentValueComparer(IPropertyBase) |
Gets a IComparer<T> for comparing values in tracked IUpdateEntry entries. |
| GetFieldName(IPropertyBase) |
Gets the name of the backing field for this property, or |
| 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. |
| GetPropertyAccessMode(IPropertyBase) |
Gets the PropertyAccessMode being used for this property.
|
| 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. |
