IConventionComplexType Interface

Definition

Namespace:

Microsoft.EntityFrameworkCore.Metadata

Assembly:

Microsoft.EntityFrameworkCore.dll

Package:

Microsoft.EntityFrameworkCore v8.0.0

Represents the type of a complex property of a structural type.

public interface IConventionComplexType : Microsoft.EntityFrameworkCore.Metadata.IConventionTypeBase, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyComplexType

type IConventionComplexType = interface
    interface IReadOnlyComplexType
    interface IReadOnlyTypeBase
    interface IReadOnlyAnnotatable
    interface IConventionTypeBase
    interface IConventionAnnotatable

Public Interface IConventionComplexType
Implements IConventionTypeBase, IReadOnlyComplexType

Implements

IReadOnlyAnnotatable IConventionAnnotatable IConventionTypeBase IReadOnlyComplexType IReadOnlyTypeBase

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 CLR class that is used to represent instances of this type. Returns null if the type does not have a corresponding CLR class (known as a shadow type). (Inherited from IReadOnlyTypeBase)
ComplexProperty	Gets the associated property.
ContainingEntityType	Gets this entity type or the one on which the complex property chain is declared. (Inherited from IReadOnlyTypeBase)
HasSharedClrType	Gets a value indicating whether this structural type is mapped to a Type that other structural types are also mapped to. (Inherited from IReadOnlyTypeBase)
IsInModel	Indicates whether this object is in a model, i.e. hasn't been removed from one. (Inherited from IConventionAnnotatable)
IsPropertyBag	Gets a value indicating whether this structural type has an indexer which is able to contain arbitrary properties and a method that can be used to determine whether a given indexer property contains a value. (Inherited from IReadOnlyTypeBase)
Item[String]	Gets the value of the annotation with the given name, returning null if it does not exist. (Inherited from IReadOnlyAnnotatable)
Model	Gets the model that this type belongs to. (Inherited from IReadOnlyTypeBase)
Name	Gets the name of this type. (Inherited from IReadOnlyTypeBase)

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)
AddComplexIndexerProperty(String, Type, Type, String, Boolean, Boolean)	Adds a property backed by and indexer to this type. (Inherited from IConventionTypeBase)
AddComplexProperty(MemberInfo, String, Boolean, Boolean)	Adds a property to this type. (Inherited from IConventionTypeBase)
AddComplexProperty(String, Boolean, Boolean)	Adds a property to this type. (Inherited from IConventionTypeBase)
AddComplexProperty(String, Type, MemberInfo, Type, String, Boolean, Boolean)	Adds a property to this type. (Inherited from IConventionTypeBase)
AddComplexProperty(String, Type, Type, String, Boolean, Boolean)	Adds a property to this type. (Inherited from IConventionTypeBase)
AddIgnored(String, Boolean)	Marks the given member name as ignored, preventing conventions from adding a matching property or navigation to the type. (Inherited from IConventionTypeBase)
AddIndexerProperty(String, Type, Boolean, Boolean)	Adds a property backed by and indexer to this entity type. (Inherited from IConventionTypeBase)
AddProperty(MemberInfo, Boolean)	Adds a property to this entity type. (Inherited from IConventionTypeBase)
AddProperty(String, Boolean)	Adds a property to this entity type. (Inherited from IConventionTypeBase)
AddProperty(String, Type, Boolean, Boolean)	Adds a property to this entity type. (Inherited from IConventionTypeBase)
AddProperty(String, Type, MemberInfo, Boolean, Boolean)	Adds a property to this entity type. (Inherited from IConventionTypeBase)
AnnotationsToDebugString(Int32)	Gets the debug string for all annotations declared on the object. (Inherited from IReadOnlyAnnotatable)
DisplayName()	Gets the friendly display name for this structural type. (Inherited from IReadOnlyTypeBase)
DisplayName(Boolean)	Gets the friendly display name for the given IReadOnlyTypeBase. (Inherited from IReadOnlyTypeBase)
FindAnnotation(String)	Gets the annotation with the given name, returning null if it does not exist. (Inherited from IConventionAnnotatable)
FindComplexProperty(MemberInfo)	Gets a complex property with the given member info. Returns null if no property is found. (Inherited from IReadOnlyTypeBase)
FindComplexProperty(String)	Gets the complex property with the given name. Returns null if no property with the given name is defined. (Inherited from IReadOnlyTypeBase)
FindDeclaredComplexProperty(String)	Finds a property declared on the type with the given name. Does not return properties defined on a base type. (Inherited from IReadOnlyTypeBase)
FindDeclaredProperty(String)	Finds a property declared on the type with the given name. Does not return properties defined on a base type. (Inherited from IReadOnlyTypeBase)
FindIgnoredConfigurationSource(String)	Indicates whether the given member name is ignored. (Inherited from IConventionTypeBase)
FindIndexerPropertyInfo()	Returns the PropertyInfo for the indexer on the associated CLR type if one exists. (Inherited from IReadOnlyTypeBase)
FindMember(String)	Gets the member with the given name. Returns null if no member with the given name is defined. (Inherited from IReadOnlyTypeBase)
FindMembersInHierarchy(String)	Gets the members with the given name on this type, base types or derived types. (Inherited from IReadOnlyTypeBase)
FindProperties(IReadOnlyList<String>)	Finds matching properties on the given type. Returns null if any property is not found. (Inherited from IReadOnlyTypeBase)
FindProperty(MemberInfo)	Gets a property with the given member info. Returns null if no property is found. (Inherited from IReadOnlyTypeBase)
FindProperty(String)	Gets the property with the given name. Returns null if no property with the given name is defined. (Inherited from IReadOnlyTypeBase)
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)
GetChangeTrackingStrategy()	Gets the change tracking strategy being used for this type. This strategy indicates how the context detects changes to properties for an instance of the type. (Inherited from IReadOnlyTypeBase)
GetChangeTrackingStrategyConfigurationSource()	Returns the configuration source for GetChangeTrackingStrategy(). (Inherited from IConventionTypeBase)
GetComplexProperties()	Gets the complex properties defined on this type and base types. (Inherited from IReadOnlyTypeBase)
GetDeclaredComplexProperties()	Gets the complex properties declared on this type. (Inherited from IReadOnlyTypeBase)
GetDeclaredMembers()	Gets the members declared on this type. (Inherited from IReadOnlyTypeBase)
GetDeclaredProperties()	Gets all scalar properties declared on this type. (Inherited from IReadOnlyTypeBase)
GetDerivedComplexProperties()	Gets the complex properties declared on the types derived from this type. (Inherited from IReadOnlyTypeBase)
GetDerivedProperties()	Gets all scalar properties declared on the types derived from this type. (Inherited from IReadOnlyTypeBase)
GetIgnoredMembers()	Gets all the ignored members. (Inherited from IConventionTypeBase)
GetMembers()	Gets the members defined on this type and base types. (Inherited from IReadOnlyTypeBase)
GetProperties()	Gets all scalar properties defined on this type. (Inherited from IReadOnlyTypeBase)
GetProperty(String)	Gets a property with the given name. (Inherited from IReadOnlyTypeBase)
GetPropertyAccessMode()	Gets the PropertyAccessMode being used for properties and navigations of this type. (Inherited from IReadOnlyTypeBase)
GetPropertyAccessModeConfigurationSource()	Returns the configuration source for GetPropertyAccessMode(). (Inherited from IConventionTypeBase)
IsAbstract()	Gets a value indicating whether this structural type represents an abstract type. (Inherited from IReadOnlyTypeBase)
IsAssignableFrom(IReadOnlyTypeBase)	Determines if this type derives from (or is the same as) a given type. (Inherited from IReadOnlyTypeBase)
IsContainedBy(Type)	Gets a value indicating whether given type is one of the containing types for this complex type. (Inherited from IReadOnlyComplexType)
IsIgnored(String)	Indicates whether the given member name is ignored. (Inherited from IConventionTypeBase)
IsStrictlyDerivedFrom(IReadOnlyTypeBase)	Determines if this type derives from (but is not the same as) a given type. (Inherited from IReadOnlyTypeBase)
RemoveAnnotation(String)	Removes the annotation with the given name from this object. (Inherited from IConventionAnnotatable)
RemoveComplexProperty(IConventionComplexProperty)	Removes a property from this type. (Inherited from IConventionTypeBase)
RemoveComplexProperty(String)	Removes a property from this type. (Inherited from IConventionTypeBase)
RemoveIgnored(String)	Removes the ignored member name. (Inherited from IConventionTypeBase)
RemoveProperty(IReadOnlyProperty)	Removes a property from this type. (Inherited from IConventionTypeBase)
RemoveProperty(String)	Removes a property from this type. (Inherited from IConventionTypeBase)
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)
SetChangeTrackingStrategy(Nullable<ChangeTrackingStrategy>, Boolean)	Sets the change tracking strategy to use for this type. This strategy indicates how the context detects changes to properties for an instance of the type. (Inherited from IConventionTypeBase)
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 null is supplied. (Inherited from IConventionAnnotatable)
SetPropertyAccessMode(Nullable<PropertyAccessMode>, Boolean)	Sets the PropertyAccessMode to use for properties of this type. (Inherited from IConventionTypeBase)
ShortName()	Gets a short name for the given IReadOnlyTypeBase that can be used in other identifiers. (Inherited from IReadOnlyTypeBase)
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 IReadOnlyComplexType)

Extension Methods

GetContainerColumnName(IReadOnlyComplexType)	Gets the container column name to which the complex type is mapped.
FindMappingFragment(IReadOnlyTypeBase, StoreObjectIdentifier)	Returns the type mapping 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.
GetContainerColumnName(IReadOnlyTypeBase)	Gets the container column name to which the type is mapped.
GetDeleteStoredProcedure(IReadOnlyTypeBase)	Returns the stored procedure to which the type is mapped for deletes or null if not mapped to a stored procedure.
GetFunctionName(IReadOnlyTypeBase)	Returns the name of the function to which the type is mapped or null if not mapped to a function.
GetInsertStoredProcedure(IReadOnlyTypeBase)	Returns the stored procedure to which the type is mapped for inserts or null if not mapped to a stored procedure.
GetJsonPropertyName(IReadOnlyTypeBase)	Gets the value of JSON property name used for the given entity mapped to a JSON column.
GetMappingFragments(IReadOnlyTypeBase)	Returns all configured type mapping fragments. This method is typically used by database providers (and other extensions). It is generally not used in application code.
GetMappingFragments(IReadOnlyTypeBase, StoreObjectType)	Returns all configured type mapping fragments of the given type. This method is typically used by database providers (and other extensions). It is generally not used in application code.
GetMappingStrategy(IReadOnlyTypeBase)	Gets the mapping strategy for the derived types.
GetSchema(IReadOnlyTypeBase)	Returns the database schema that contains the mapped table.
GetSqlQuery(IReadOnlyTypeBase)	Returns the SQL string used to provide data for the type or null if not mapped to a SQL string.
GetTableName(IReadOnlyTypeBase)	Returns the name of the table to which the type is mapped or null if not mapped to a table.
GetUpdateStoredProcedure(IReadOnlyTypeBase)	Returns the stored procedure to which the type is mapped for updates or null if not mapped to a stored procedure.
GetViewName(IReadOnlyTypeBase)	Returns the name of the view to which the type is mapped or null if not mapped to a view.
GetViewSchema(IReadOnlyTypeBase)	Returns the database schema that contains the mapped view.
IsMappedToJson(IReadOnlyTypeBase)	Gets a value indicating whether the specified entity is mapped to a JSON column.