Property Property Class

Definition

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public class Property : PropertyBase, IMutableProperty, IProperty, IMutablePropertyBase, IPropertyBase, IMutableAnnotatable, IAnnotatable
Public Class Property
    Inherits PropertyBase
    Implements IMutableProperty, IProperty, IMutablePropertyBase, IPropertyBase, IMutableAnnotatable, IAnnotatable
Inheritance
Implements

Constructors

Property(String, Type, PropertyInfo, FieldInfo, EntityType, ConfigurationSource) Property(String, Type, PropertyInfo, FieldInfo, EntityType, ConfigurationSource)

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public Property(string name, Type clrType, PropertyInfo propertyInfo, FieldInfo fieldInfo, EntityType declaringEntityType, ConfigurationSource configurationSource)
Public Sub New(name As String, clrType As Type, propertyInfo As PropertyInfo, fieldInfo As FieldInfo, declaringEntityType As EntityType, configurationSource As ConfigurationSource)
Parameters
name
System.String System.String
clrType
System.Type System.Type
propertyInfo
System.Reflection.PropertyInfo System.Reflection.PropertyInfo
fieldInfo
System.Reflection.FieldInfo System.Reflection.FieldInfo
declaringEntityType
EntityType EntityType

Properties

Accessors Accessors

Inherited from PropertyBase

Builder Builder

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual InternalPropertyBuilder Builder { get; set; }
Public Overridable Property Builder As InternalPropertyBuilder

ClrType ClrType

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public override Type ClrType { get; }
Public Overrides ReadOnly Property ClrType As Type
Value
System.Type System.Type
Overrides

DebugView DebugView

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual DebugView<Property> DebugView { get; }
Public Overridable ReadOnly Property DebugView As DebugView(Of  Property)

DeclaringEntityType DeclaringEntityType

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual EntityType DeclaringEntityType { get; }
Public Overridable ReadOnly Property DeclaringEntityType As EntityType

DeclaringType DeclaringType

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual EntityType DeclaringType { get; }
Public Overridable ReadOnly Property DeclaringType As EntityType

FieldInfo FieldInfo

Inherited from PropertyBase

ForeignKeys ForeignKeys

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual IReadOnlyList<IForeignKey> ForeignKeys { get; set; }
Public Overridable Property ForeignKeys As IReadOnlyList(Of IForeignKey)
Value
System.Collections.Generic.IReadOnlyList<IForeignKey> System.Collections.Generic.IReadOnlyList(Of IForeignKey)

Getter Getter

Inherited from PropertyBase

IPropertyBase.DeclaringEntityType Microsoft.EntityFrameworkCore.Metadata.IPropertyBase.DeclaringEntityType

Inherited from PropertyBase

Indexes Indexes

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual IReadOnlyList<IIndex> Indexes { get; set; }
Public Overridable Property Indexes As IReadOnlyList(Of IIndex)
Value
System.Collections.Generic.IReadOnlyList<IIndex> System.Collections.Generic.IReadOnlyList(Of IIndex)

IsConcurrencyToken IsConcurrencyToken

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual bool IsConcurrencyToken { get; set; }
Public Overridable Property IsConcurrencyToken As Boolean
Value
System.Boolean System.Boolean

IsNullable IsNullable

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual bool IsNullable { get; set; }
Public Overridable Property IsNullable As Boolean
Value
System.Boolean System.Boolean

IsReadOnlyAfterSave IsReadOnlyAfterSave

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual bool IsReadOnlyAfterSave { get; set; }
Public Overridable Property IsReadOnlyAfterSave As Boolean
Value
System.Boolean System.Boolean

IsReadOnlyBeforeSave IsReadOnlyBeforeSave

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual bool IsReadOnlyBeforeSave { get; set; }
Public Overridable Property IsReadOnlyBeforeSave As Boolean
Value
System.Boolean System.Boolean

IsShadowProperty IsShadowProperty

Inherited from PropertyBase

IsStoreGeneratedAlways IsStoreGeneratedAlways

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual bool IsStoreGeneratedAlways { get; set; }
Public Overridable Property IsStoreGeneratedAlways As Boolean
Value
System.Boolean System.Boolean

Item[String] Item(String)

Inherited from Annotatable

Keys Keys

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual IReadOnlyList<IKey> Keys { get; set; }
Public Overridable Property Keys As IReadOnlyList(Of IKey)
Value
System.Collections.Generic.IReadOnlyList<IKey> System.Collections.Generic.IReadOnlyList(Of IKey)

MemberInfo MemberInfo

Inherited from PropertyBase

Name Name

Inherited from PropertyBase

PrimaryKey PrimaryKey

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual IKey PrimaryKey { get; set; }
Public Overridable Property PrimaryKey As IKey
Value
IKey IKey

PropertyIndexes PropertyIndexes

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual PropertyIndexes PropertyIndexes { get; set; }
Public Overridable Property PropertyIndexes As PropertyIndexes

PropertyInfo PropertyInfo

Inherited from PropertyBase

RequiresValueGenerator RequiresValueGenerator

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual bool RequiresValueGenerator { get; set; }
Public Overridable Property RequiresValueGenerator As Boolean
Value
System.Boolean System.Boolean

Setter Setter

Inherited from PropertyBase

ValueGenerated ValueGenerated

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual ValueGenerated ValueGenerated { get; set; }
Public Overridable Property ValueGenerated As ValueGenerated

Methods

AddAnnotation(String, Annotation) AddAnnotation(String, Annotation)

Inherited from Annotatable

AddAnnotation(String, Object) AddAnnotation(String, Object)

Inherited from ConventionalAnnotatable

AddAnnotation(String, Object, ConfigurationSource) AddAnnotation(String, Object, ConfigurationSource)

Inherited from ConventionalAnnotatable

AreCompatible(IReadOnlyList, EntityType) AreCompatible(IReadOnlyList(Of Property), EntityType)

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public static bool AreCompatible(IReadOnlyList<Property> properties, EntityType entityType)
Public Shared Function AreCompatible(properties As IReadOnlyList(Of  Property), entityType As EntityType) As Boolean
Parameters
properties
System.Collections.Generic.IReadOnlyList<Property> System.Collections.Generic.IReadOnlyList(Of Property)
entityType
EntityType EntityType
Returns
System.Boolean System.Boolean

CreateAnnotation(String, Object) CreateAnnotation(String, Object)

Inherited from ConventionalAnnotatable

Equals(Object) Equals(Object)

Inherited from System.Object

Equals(Object, Object) Equals(Object, Object)

Inherited from System.Object

FindAnnotation(String) FindAnnotation(String)

Inherited from ConventionalAnnotatable

Format(IEnumerable, Boolean) Format(IEnumerable(Of IProperty), Boolean)

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public static string Format(IEnumerable<IProperty> properties, bool includeTypes = false)
Public Shared Function Format(properties As IEnumerable(Of IProperty), includeTypes As Boolean = False) As String
Parameters
properties
System.Collections.Generic.IEnumerable<IProperty> System.Collections.Generic.IEnumerable(Of IProperty)
includeTypes
System.Boolean System.Boolean
Returns
System.String System.String

GetAnnotations() GetAnnotations()

Inherited from ConventionalAnnotatable

GetConfigurationSource() GetConfigurationSource()

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual ConfigurationSource GetConfigurationSource()
Public Overridable Function GetConfigurationSource As ConfigurationSource
Returns

GetContainingForeignKeys() GetContainingForeignKeys()

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual IEnumerable<ForeignKey> GetContainingForeignKeys()
Public Overridable Function GetContainingForeignKeys As IEnumerable(Of ForeignKey)
Returns
System.Collections.Generic.IEnumerable<ForeignKey> System.Collections.Generic.IEnumerable(Of ForeignKey)

GetContainingIndexes() GetContainingIndexes()

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual IEnumerable<Index> GetContainingIndexes()
Public Overridable Function GetContainingIndexes As IEnumerable(Of Index)
Returns
System.Collections.Generic.IEnumerable<Index> System.Collections.Generic.IEnumerable(Of Index)

GetContainingKeys() GetContainingKeys()

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual IEnumerable<Key> GetContainingKeys()
Public Overridable Function GetContainingKeys As IEnumerable(Of Key)
Returns
System.Collections.Generic.IEnumerable<Key> System.Collections.Generic.IEnumerable(Of Key)

GetFieldInfoConfigurationSource() GetFieldInfoConfigurationSource()

Inherited from PropertyBase

GetHashCode() GetHashCode()

Inherited from System.Object

GetIsConcurrencyTokenConfigurationSource() GetIsConcurrencyTokenConfigurationSource()

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual ConfigurationSource? GetIsConcurrencyTokenConfigurationSource()
Public Overridable Function GetIsConcurrencyTokenConfigurationSource As ConfigurationSource?
Returns
System.Nullable<ConfigurationSource> System.Nullable(Of ConfigurationSource)

GetIsNullableConfigurationSource() GetIsNullableConfigurationSource()

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual ConfigurationSource? GetIsNullableConfigurationSource()
Public Overridable Function GetIsNullableConfigurationSource As ConfigurationSource?
Returns
System.Nullable<ConfigurationSource> System.Nullable(Of ConfigurationSource)

GetIsReadOnlyAfterSaveConfigurationSource() GetIsReadOnlyAfterSaveConfigurationSource()

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual ConfigurationSource? GetIsReadOnlyAfterSaveConfigurationSource()
Public Overridable Function GetIsReadOnlyAfterSaveConfigurationSource As ConfigurationSource?
Returns
System.Nullable<ConfigurationSource> System.Nullable(Of ConfigurationSource)

GetIsReadOnlyBeforeSaveConfigurationSource() GetIsReadOnlyBeforeSaveConfigurationSource()

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual ConfigurationSource? GetIsReadOnlyBeforeSaveConfigurationSource()
Public Overridable Function GetIsReadOnlyBeforeSaveConfigurationSource As ConfigurationSource?
Returns
System.Nullable<ConfigurationSource> System.Nullable(Of ConfigurationSource)

GetIsStoreGeneratedAlwaysConfigurationSource() GetIsStoreGeneratedAlwaysConfigurationSource()

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual ConfigurationSource? GetIsStoreGeneratedAlwaysConfigurationSource()
Public Overridable Function GetIsStoreGeneratedAlwaysConfigurationSource As ConfigurationSource?
Returns
System.Nullable<ConfigurationSource> System.Nullable(Of ConfigurationSource)

GetOrAddAnnotation(String, Object) GetOrAddAnnotation(String, Object)

Inherited from ConventionalAnnotatable

GetRequiresValueGeneratorConfigurationSource() GetRequiresValueGeneratorConfigurationSource()

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual ConfigurationSource? GetRequiresValueGeneratorConfigurationSource()
Public Overridable Function GetRequiresValueGeneratorConfigurationSource As ConfigurationSource?
Returns
System.Nullable<ConfigurationSource> System.Nullable(Of ConfigurationSource)

GetType() GetType()

Inherited from System.Object

GetValueGeneratedConfigurationSource() GetValueGeneratedConfigurationSource()

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual ConfigurationSource? GetValueGeneratedConfigurationSource()
Public Overridable Function GetValueGeneratedConfigurationSource As ConfigurationSource?
Returns
System.Nullable<ConfigurationSource> System.Nullable(Of ConfigurationSource)

MemberwiseClone() MemberwiseClone()

Inherited from System.Object

OnAnnotationSet(String, Annotation, Annotation) OnAnnotationSet(String, Annotation, Annotation)

Inherited from Annotatable

OnFieldInfoSet(FieldInfo) OnFieldInfoSet(FieldInfo)

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

protected override void OnFieldInfoSet(FieldInfo oldFieldInfo)
Protected Overrides Sub OnFieldInfoSet(oldFieldInfo As FieldInfo)
Parameters
oldFieldInfo
System.Reflection.FieldInfo System.Reflection.FieldInfo
Overrides

PropertyMetadataChanged() PropertyMetadataChanged()

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

protected override void PropertyMetadataChanged()
Protected Overrides Sub PropertyMetadataChanged
Overrides

ReferenceEquals(Object, Object) ReferenceEquals(Object, Object)

Inherited from System.Object

RemoveAnnotation(String) RemoveAnnotation(String)

Inherited from ConventionalAnnotatable

SetAnnotation(String, Annotation) SetAnnotation(String, Annotation)

Inherited from Annotatable

SetAnnotation(String, Object, ConfigurationSource) SetAnnotation(String, Object, ConfigurationSource)

Inherited from ConventionalAnnotatable

SetConfigurationSource(ConfigurationSource) SetConfigurationSource(ConfigurationSource)

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual void SetConfigurationSource(ConfigurationSource configurationSource)
Public Overridable Sub SetConfigurationSource(configurationSource As ConfigurationSource)
Parameters

SetField(String, ConfigurationSource) SetField(String, ConfigurationSource)

Inherited from PropertyBase

SetFieldInfo(FieldInfo, ConfigurationSource, Boolean) SetFieldInfo(FieldInfo, ConfigurationSource, Boolean)

Inherited from PropertyBase

SetIsConcurrencyToken(Boolean, ConfigurationSource) SetIsConcurrencyToken(Boolean, ConfigurationSource)

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual void SetIsConcurrencyToken(bool concurrencyToken, ConfigurationSource configurationSource)
Public Overridable Sub SetIsConcurrencyToken(concurrencyToken As Boolean, configurationSource As ConfigurationSource)
Parameters
concurrencyToken
System.Boolean System.Boolean

SetIsNullable(Boolean, ConfigurationSource) SetIsNullable(Boolean, ConfigurationSource)

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual void SetIsNullable(bool nullable, ConfigurationSource configurationSource)
Public Overridable Sub SetIsNullable(nullable As Boolean, configurationSource As ConfigurationSource)
Parameters
nullable
System.Boolean System.Boolean

SetIsReadOnlyAfterSave(Boolean, ConfigurationSource) SetIsReadOnlyAfterSave(Boolean, ConfigurationSource)

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual void SetIsReadOnlyAfterSave(bool readOnlyAfterSave, ConfigurationSource configurationSource)
Public Overridable Sub SetIsReadOnlyAfterSave(readOnlyAfterSave As Boolean, configurationSource As ConfigurationSource)
Parameters
readOnlyAfterSave
System.Boolean System.Boolean

SetIsReadOnlyBeforeSave(Boolean, ConfigurationSource) SetIsReadOnlyBeforeSave(Boolean, ConfigurationSource)

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual void SetIsReadOnlyBeforeSave(bool readOnlyBeforeSave, ConfigurationSource configurationSource)
Public Overridable Sub SetIsReadOnlyBeforeSave(readOnlyBeforeSave As Boolean, configurationSource As ConfigurationSource)
Parameters
readOnlyBeforeSave
System.Boolean System.Boolean

SetIsStoreGeneratedAlways(Boolean, ConfigurationSource) SetIsStoreGeneratedAlways(Boolean, ConfigurationSource)

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual void SetIsStoreGeneratedAlways(bool storeGeneratedAlways, ConfigurationSource configurationSource)
Public Overridable Sub SetIsStoreGeneratedAlways(storeGeneratedAlways As Boolean, configurationSource As ConfigurationSource)
Parameters
storeGeneratedAlways
System.Boolean System.Boolean

SetRequiresValueGenerator(Boolean, ConfigurationSource) SetRequiresValueGenerator(Boolean, ConfigurationSource)

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual void SetRequiresValueGenerator(bool requiresValueGenerator, ConfigurationSource configurationSource)
Public Overridable Sub SetRequiresValueGenerator(requiresValueGenerator As Boolean, configurationSource As ConfigurationSource)
Parameters
requiresValueGenerator
System.Boolean System.Boolean

SetValueGenerated(Nullable, ConfigurationSource) SetValueGenerated(Nullable(Of ValueGenerated), ConfigurationSource)

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual void SetValueGenerated(ValueGenerated? valueGenerated, ConfigurationSource configurationSource)
Public Overridable Sub SetValueGenerated(valueGenerated As ValueGenerated?, configurationSource As ConfigurationSource)
Parameters
valueGenerated
System.Nullable<ValueGenerated> System.Nullable(Of ValueGenerated)

ToString() ToString()

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public override string ToString()
Public Overrides Function ToString As String
Returns
System.String System.String
Overrides
System.Object.ToString()System.Object.ToString()

UpdateConfigurationSource(ConfigurationSource) UpdateConfigurationSource(ConfigurationSource)

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public virtual void UpdateConfigurationSource(ConfigurationSource configurationSource)
Public Overridable Sub UpdateConfigurationSource(configurationSource As ConfigurationSource)
Parameters

Explicit Interface Implementations

IAnnotatable.FindAnnotation(String) Microsoft.EntityFrameworkCore.Infrastructure.IAnnotatable.FindAnnotation(String)

Inherited from Annotatable

IAnnotatable.GetAnnotations() Microsoft.EntityFrameworkCore.Infrastructure.IAnnotatable.GetAnnotations()

Inherited from Annotatable

IMutableProperty.DeclaringEntityType Microsoft.EntityFrameworkCore.Metadata.IMutableProperty.DeclaringEntityType

IMutableEntityType IMutableProperty.DeclaringEntityType { get; }
ReadOnly WriteOnly Property Microsoft.EntityFrameworkCore.Metadata.IMutableProperty.DeclaringEntityType As IMutableEntityType Implements IMutableProperty.DeclaringEntityType
Returns

IMutablePropertyBase.DeclaringType Microsoft.EntityFrameworkCore.Metadata.IMutablePropertyBase.DeclaringType

IMutableTypeBase IMutablePropertyBase.DeclaringType { get; }
ReadOnly WriteOnly Property Microsoft.EntityFrameworkCore.Metadata.IMutablePropertyBase.DeclaringType As IMutableTypeBase Implements IMutablePropertyBase.DeclaringType
Returns

IProperty.DeclaringEntityType Microsoft.EntityFrameworkCore.Metadata.IProperty.DeclaringEntityType

IEntityType IProperty.DeclaringEntityType { get; }
ReadOnly WriteOnly Property Microsoft.EntityFrameworkCore.Metadata.IProperty.DeclaringEntityType As IEntityType Implements IProperty.DeclaringEntityType
Returns

IPropertyBase.DeclaringType Microsoft.EntityFrameworkCore.Metadata.IPropertyBase.DeclaringType

ITypeBase IPropertyBase.DeclaringType { get; }
ReadOnly WriteOnly Property Microsoft.EntityFrameworkCore.Metadata.IPropertyBase.DeclaringType As ITypeBase Implements IPropertyBase.DeclaringType
Returns