Share via


IComplexProperty Interface

Definition

Represents a complex property of a structural type.

public interface IComplexProperty : Microsoft.EntityFrameworkCore.Metadata.IPropertyBase, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyComplexProperty
type IComplexProperty = interface
    interface IReadOnlyComplexProperty
    interface IReadOnlyPropertyBase
    interface IReadOnlyAnnotatable
    interface IPropertyBase
    interface IAnnotatable
Public Interface IComplexProperty
Implements IPropertyBase, IReadOnlyComplexProperty
Derived
Implements

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.

DeclaringEntityType
Obsolete.

Gets the entity type that this property belongs to.

(Inherited from IPropertyBase)
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.

(Inherited from IReadOnlyComplexProperty)
IsNullable

Gets a value indicating whether this property can contain null.

(Inherited from IReadOnlyComplexProperty)
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

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 null if it does not exist.

(Inherited from IReadOnlyAnnotatable)
FindRuntimeAnnotation(String)

Gets the runtime annotation with the given name, returning null if it does not exist.

(Inherited from IAnnotatable)
FindRuntimeAnnotationValue(String)

Gets the value of the runtime annotation with the given name, returning null if it does not exist.

(Inherited from IAnnotatable)
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)
GetCurrentValueComparer()

Gets a IComparer<T> for comparing values in tracked IUpdateEntry entries.

(Inherited from IPropertyBase)
GetFieldName()

Gets the name of the backing field for this property, or null if the backing field is not known.

(Inherited from IReadOnlyPropertyBase)
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)
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)
RemoveRuntimeAnnotation(String)

Removes the given runtime annotation from this object.

(Inherited from IAnnotatable)
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)
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)

Extension Methods

GetCurrentValueComparer(IPropertyBase)

Gets a IComparer<T> for comparing values in tracked IUpdateEntry entries.

GetIndex(IPropertyBase)

Gets the property index 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.

Applies to