Class PropertyBase

Namespace

Microsoft.EntityFrameworkCore.Metadata.Internal

Assembly

Microsoft.EntityFrameworkCore.dll

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public abstract class PropertyBase : ConventionAnnotatable, IMutablePropertyBase, IMutableAnnotatable, IConventionPropertyBase, IConventionAnnotatable, IRuntimePropertyBase, IPropertyBase, IReadOnlyPropertyBase, IAnnotatable, IReadOnlyAnnotatable

Inheritance

object

AnnotatableBase

Annotatable

ConventionAnnotatable

PropertyBase

Implements

IMutablePropertyBase

IMutableAnnotatable

IConventionPropertyBase

IConventionAnnotatable

IRuntimePropertyBase

IPropertyBase

IReadOnlyPropertyBase

IAnnotatable

IReadOnlyAnnotatable

Derived

ComplexProperty

Navigation

Property

ServiceProperty

SkipNavigation

Inherited Members

ConventionAnnotatable.GetAnnotations()

ConventionAnnotatable.AddAnnotation(string, object, ConfigurationSource)

ConventionAnnotatable.SetAnnotation(string, object)

ConventionAnnotatable.SetAnnotation(string, object, ConfigurationSource)

ConventionAnnotatable.SetOrRemoveAnnotation(string, object, ConfigurationSource)

ConventionAnnotatable.OnAnnotationSet(string, Annotation, Annotation)

ConventionAnnotatable.OnAnnotationSet(string, IConventionAnnotation, IConventionAnnotation)

ConventionAnnotatable.FindAnnotation(string)

ConventionAnnotatable.CreateAnnotation(string, object)

Annotatable.EnsureReadOnly()

Annotatable.EnsureMutable()

AnnotatableBase.AddAnnotation(string, object)

AnnotatableBase.AddAnnotation(string, Annotation)

AnnotatableBase.AddAnnotations(IEnumerable<IAnnotation>)

AnnotatableBase.AddAnnotations(IReadOnlyDictionary<string, object>)

AnnotatableBase.SetAnnotation(string, Annotation, Annotation)

AnnotatableBase.GetAnnotation(string)

AnnotatableBase.RemoveAnnotation(string)

AnnotatableBase.GetRuntimeAnnotations()

AnnotatableBase.AddRuntimeAnnotation(string, object)

AnnotatableBase.AddRuntimeAnnotation(string, Annotation)

AnnotatableBase.AddRuntimeAnnotations(IEnumerable<Annotation>)

AnnotatableBase.AddRuntimeAnnotations(IReadOnlyDictionary<string, object>)

AnnotatableBase.SetRuntimeAnnotation(string, object)

AnnotatableBase.SetRuntimeAnnotation(string, Annotation, Annotation)

AnnotatableBase.GetOrAddRuntimeAnnotationValue<TValue, TArg>(string, Func<TArg, TValue>, TArg)

AnnotatableBase.FindRuntimeAnnotation(string)

AnnotatableBase.RemoveRuntimeAnnotation(string)

AnnotatableBase.CreateRuntimeAnnotation(string, object)

AnnotatableBase.this[string]

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

PropertyBaseExtensions.IsIndexerProperty(PropertyBase)

PropertyBaseExtensions.IsShadowProperty(PropertyBase)

PropertyBaseExtensions.GetOriginalValueIndex(IPropertyBase)

PropertyBaseExtensions.GetPropertyAccessors(IPropertyBase)

PropertyBaseExtensions.GetPropertyIndexes(IPropertyBase)

PropertyBaseExtensions.GetRelationshipIndex(IPropertyBase)

PropertyBaseExtensions.GetShadowIndex(IPropertyBase)

PropertyBaseExtensions.GetStoreGeneratedIndex(IPropertyBase)

PropertyBaseExtensions.TryGetMemberInfo(IPropertyBase, bool, bool, out MemberInfo?, out string?)

PropertyBaseExtensions.GetIdentifyingMemberInfo(IReadOnlyPropertyBase)

Constructors

PropertyBase(string, PropertyInfo?, FieldInfo?, ConfigurationSource)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

protected PropertyBase(string name, PropertyInfo? propertyInfo, FieldInfo? fieldInfo, ConfigurationSource configurationSource)

Parameters

name string

propertyInfo PropertyInfo

fieldInfo FieldInfo

configurationSource ConfigurationSource

Properties

Accessors

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual PropertyAccessors Accessors { get; }

Property Value

PropertyAccessors

ClrType

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public abstract Type ClrType { get; }

Property Value

Type

CurrentValueComparer

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual IComparer<IUpdateEntry> CurrentValueComparer { get; }

Property Value

IComparer<IUpdateEntry>

DeclaringType

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public abstract TypeBase DeclaringType { get; }

Property Value

TypeBase

FieldInfo

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual FieldInfo? FieldInfo { get; set; }

Property Value

FieldInfo

Getter

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual IClrPropertyGetter Getter { get; }

Property Value

IClrPropertyGetter

IsReadOnly

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public override bool IsReadOnly { get; }

Property Value

bool

MaterializationSetter

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual IClrPropertySetter MaterializationSetter { get; }

Property Value

IClrPropertySetter

Name

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual string Name { get; }

Property Value

string

PropertyIndexes

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual PropertyIndexes PropertyIndexes { get; set; }

Property Value

PropertyIndexes

PropertyInfo

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual PropertyInfo? PropertyInfo { get; }

Property Value

PropertyInfo

Methods

CreateMemberAccess(IPropertyBase?, Expression, MemberInfo, bool)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public static Expression CreateMemberAccess(IPropertyBase? property, Expression instanceExpression, MemberInfo memberInfo, bool fromContainingType)

Parameters

property IPropertyBase

instanceExpression Expression

memberInfo MemberInfo

fromContainingType bool

Returns

Expression

GetConfigurationSource()

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual ConfigurationSource GetConfigurationSource()

Returns

ConfigurationSource

GetFieldInfo(string, TypeBase, string, bool)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public static FieldInfo? GetFieldInfo(string fieldName, TypeBase type, string propertyName, bool shouldThrow)

Parameters

fieldName string

type TypeBase

propertyName string

shouldThrow bool

Returns

FieldInfo

GetFieldInfoConfigurationSource()

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual ConfigurationSource? GetFieldInfoConfigurationSource()

Returns

ConfigurationSource?

GetPropertyAccessMode()

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual PropertyAccessMode GetPropertyAccessMode()

Returns

PropertyAccessMode

GetPropertyAccessModeConfigurationSource()

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual ConfigurationSource? GetPropertyAccessModeConfigurationSource()

Returns

ConfigurationSource?

GetSetter()

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual IClrPropertySetter GetSetter()

Returns

IClrPropertySetter

IsCompatible(FieldInfo, Type?, Type?, string?, bool)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public static bool IsCompatible(FieldInfo fieldInfo, Type? propertyType, Type? entityType, string? propertyName, bool shouldThrow)

Parameters

fieldInfo FieldInfo

propertyType Type

entityType Type

propertyName string

shouldThrow bool

Returns

bool

OnFieldInfoSet(FieldInfo?, FieldInfo?)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

protected virtual FieldInfo? OnFieldInfoSet(FieldInfo? newFieldInfo, FieldInfo? oldFieldInfo)

Parameters

newFieldInfo FieldInfo

oldFieldInfo FieldInfo

Returns

FieldInfo

SetConfigurationSource(ConfigurationSource)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual void SetConfigurationSource(ConfigurationSource configurationSource)

Parameters

configurationSource ConfigurationSource

SetField(string?, ConfigurationSource)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual FieldInfo? SetField(string? fieldName, ConfigurationSource configurationSource)

Parameters

fieldName string

configurationSource ConfigurationSource

Returns

FieldInfo

SetFieldInfo(FieldInfo?, ConfigurationSource)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual FieldInfo? SetFieldInfo(FieldInfo? fieldInfo, ConfigurationSource configurationSource)

Parameters

fieldInfo FieldInfo

configurationSource ConfigurationSource

Returns

FieldInfo

SetPropertyAccessMode(PropertyAccessMode?, ConfigurationSource)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual PropertyAccessMode? SetPropertyAccessMode(PropertyAccessMode? propertyAccessMode, ConfigurationSource configurationSource)

Parameters

propertyAccessMode PropertyAccessMode?

configurationSource ConfigurationSource

Returns

PropertyAccessMode?

UpdateConfigurationSource(ConfigurationSource)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual void UpdateConfigurationSource(ConfigurationSource configurationSource)

Parameters

configurationSource ConfigurationSource