IReadOnlyTypeBase Interface

Reference

Definition

Namespace:: Microsoft.EntityFrameworkCore.Metadata

Assembly:: Microsoft.EntityFrameworkCore.dll

Package:: Microsoft.EntityFrameworkCore v6.0.0

Package:: Microsoft.EntityFrameworkCore v7.0.0

Package:: Microsoft.EntityFrameworkCore v8.0.0

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 structural type in the model.

public interface IReadOnlyTypeBase : Microsoft.EntityFrameworkCore.Infrastructure.IReadOnlyAnnotatable

type IReadOnlyTypeBase = interface
    interface IReadOnlyAnnotatable

Public Interface IReadOnlyTypeBase
Implements IReadOnlyAnnotatable

Derived: Microsoft.EntityFrameworkCore.Metadata.IComplexType

Microsoft.EntityFrameworkCore.Metadata.IConventionComplexType

Microsoft.EntityFrameworkCore.Metadata.IConventionEntityType

Microsoft.EntityFrameworkCore.Metadata.IConventionTypeBase

Microsoft.EntityFrameworkCore.Metadata.IEntityType

More…

Implements: IReadOnlyAnnotatable

Remarks

See Modeling entity types and relationships for more information and examples.

Properties

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).
ContainingEntityType	Gets this entity type or the one on which the complex property chain is declared.
HasSharedClrType	Gets a value indicating whether this structural type is mapped to a Type that other structural types are also mapped to.
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.
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.
Name	Gets the name of this type.

Methods

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.
DisplayName(Boolean)	Gets the friendly display name for the given IReadOnlyTypeBase.
FindAnnotation(String)	Gets the annotation with the given name, returning `null` if it does not exist. (Inherited from IReadOnlyAnnotatable)
FindComplexProperty(MemberInfo)	Gets a complex property with the given member info. Returns `null` if no property is found.
FindComplexProperty(String)	Gets the complex property with the given name. Returns `null` if no property with the given name is defined.
FindDeclaredComplexProperty(String)	Finds a property declared on the type with the given name. Does not return properties defined on a base type.
FindDeclaredProperty(String)	Finds a property declared on the type with the given name. Does not return properties defined on a base type.
FindIndexerPropertyInfo()	Returns the PropertyInfo for the indexer on the associated CLR type if one exists.
FindMember(String)	Gets the member with the given name. Returns `null` if no member with the given name is defined.
FindMembersInHierarchy(String)	Gets the members with the given name on this type, base types or derived types.
FindProperties(IReadOnlyList<String>)	Finds matching properties on the given type. Returns `null` if any property is not found.
FindProperty(MemberInfo)	Gets a property with the given member info. Returns `null` if no property is found.
FindProperty(String)	Gets the property with the given name. Returns `null` if no property with the given name is defined.
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)
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.
GetComplexProperties()	Gets the complex properties defined on this type and base types.
GetDeclaredComplexProperties()	Gets the complex properties declared on this type.
GetDeclaredMembers()	Gets the members declared on this type.
GetDeclaredProperties()	Gets all scalar properties declared on this type.
GetDerivedComplexProperties()	Gets the complex properties declared on the types derived from this type.
GetDerivedProperties()	Gets all scalar properties declared on the types derived from this type.
GetMembers()	Gets the members defined on this type and base types.
GetNavigationAccessMode()	Gets the PropertyAccessMode being used for navigations of this type.
GetProperties()	Gets all scalar properties defined on this type.
GetProperty(String)	Gets a property with the given name.
GetPropertyAccessMode()	Gets the PropertyAccessMode being used for properties and navigations of this type.
IsAbstract()	Gets a value indicating whether this structural type represents an abstract type.
IsAssignableFrom(IReadOnlyTypeBase)	Determines if this type derives from (or is the same as) a given type.
IsStrictlyDerivedFrom(IReadOnlyTypeBase)	Determines if this type derives from (but is not the same as) a given type.
ShortName()	Gets a short name for the given IReadOnlyTypeBase that can be used in other identifiers.

Extension Methods

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.

Applies to