IConventionComplexProperty 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.
Represents a complex property of a structural type.
public interface IConventionComplexProperty : Microsoft.EntityFrameworkCore.Metadata.IConventionPropertyBase, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyComplexPropertytype IConventionComplexProperty = interface
interface IReadOnlyComplexProperty
interface IReadOnlyPropertyBase
interface IReadOnlyAnnotatable
interface IConventionPropertyBase
interface IConventionAnnotatablePublic Interface IConventionComplexProperty
Implements IConventionPropertyBase, IReadOnlyComplexProperty- Implements
Remarks
This interface is used during model creation and allows the metadata to be modified. Once the model is built, IComplexProperty 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 property. |
| ClrType |
Gets the type of value that this property-like object holds. (Inherited from IReadOnlyPropertyBase) |
| ComplexType |
Gets the associated complex type. |
| DeclaringType |
Gets the type that this property-like object belongs to. (Inherited from IReadOnlyPropertyBase) |
| FieldInfo |
Gets the FieldInfo for the underlying CLR field for this property-like object.
This may be |
| IsCollection |
Gets a value indicating whether this property represents a collection. (Inherited from IReadOnlyComplexProperty) |
| IsInModel |
Indicates whether this object is in a model, i.e. hasn't been removed from one. (Inherited from IConventionAnnotatable) |
| IsNullable |
Gets a value indicating whether this property can contain |
| 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) |
| 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 |
| GetAnnotation(String) |
Gets the annotation with the given name, throwing if it does not exist. (Inherited from IConventionAnnotatable) |
| GetAnnotations() |
Gets all annotations on the current object. (Inherited from IConventionAnnotatable) |
| GetConfigurationSource() |
Returns the configuration source for this property. (Inherited from IConventionPropertyBase) |
| GetFieldInfoConfigurationSource() |
Returns the configuration source for FieldInfo. (Inherited from IConventionPropertyBase) |
| GetFieldName() |
Gets the name of the backing field for this property, or |
| GetIsNullableConfigurationSource() |
Returns the configuration source for IsNullable. |
| GetPropertyAccessMode() |
Gets the PropertyAccessMode being used for this property-like object. (Inherited from IReadOnlyPropertyBase) |
| GetPropertyAccessModeConfigurationSource() |
Returns the configuration source for GetPropertyAccessMode(). (Inherited from IConventionPropertyBase) |
| 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) |
| 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). (Inherited from IConventionPropertyBase) |
| 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. (Inherited from IConventionPropertyBase) |
| SetIsNullable(Nullable<Boolean>, Boolean) |
Sets a value indicating whether this property can contain |
| 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. (Inherited from IConventionPropertyBase) |
| ToDebugString(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. (Inherited from IReadOnlyComplexProperty) |
