IReadOnlyComplexProperty Interface

Definition

Namespace:

Microsoft.EntityFrameworkCore.Metadata

Assembly:

Microsoft.EntityFrameworkCore.dll

Package:

Microsoft.EntityFrameworkCore v9.0.0

Source:

IReadOnlyComplexProperty.cs

Represents a complex property of a structural type.

public interface IReadOnlyComplexProperty : Microsoft.EntityFrameworkCore.Metadata.IReadOnlyPropertyBase

type IReadOnlyComplexProperty = interface
    interface IReadOnlyPropertyBase
    interface IReadOnlyAnnotatable

Public Interface IReadOnlyComplexProperty
Implements IReadOnlyPropertyBase

Derived

Microsoft.EntityFrameworkCore.Metadata.IComplexProperty

Microsoft.EntityFrameworkCore.Metadata.IConventionComplexProperty

Microsoft.EntityFrameworkCore.Metadata.IMutableComplexProperty

Microsoft.EntityFrameworkCore.Metadata.RuntimeComplexProperty

Implements

IReadOnlyAnnotatable IReadOnlyPropertyBase

Remarks

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

Properties

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 null for shadow properties or if the backing field is not known. (Inherited from IReadOnlyPropertyBase)
IsCollection	Gets a value indicating whether this property represents a collection.
IsNullable	Gets a value indicating whether this property can contain null.
Item[String]	Gets the value of the annotation with the given name, returning null if it does not exist. (Inherited from IReadOnlyAnnotatable)
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 null for shadow properties or if mapped directly to a field. (Inherited from IReadOnlyPropertyBase)
Sentinel	Gets the sentinel value that indicates that this property is not set. (Inherited from IReadOnlyPropertyBase)

Methods

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 null if it does not exist. (Inherited from IReadOnlyAnnotatable)
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)
GetFieldName()	Gets the name of the backing field for this property, or null if the backing field is not known. (Inherited from IReadOnlyPropertyBase)
GetPropertyAccessMode()	Gets the PropertyAccessMode being used for this property-like object. (Inherited from IReadOnlyPropertyBase)
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)
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.