Language

IConventionServiceProperty インターフェイス

定義

DbContextから挿入されたサービスを表す Entity Framework モデルのIReadOnlyPropertyBase。

public interface IConventionServiceProperty : Microsoft.EntityFrameworkCore.Metadata.IConventionPropertyBase, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyServiceProperty
public interface IConventionServiceProperty : Microsoft.EntityFrameworkCore.Metadata.IConventionPropertyBase, Microsoft.EntityFrameworkCore.Metadata.IServiceProperty
type IConventionServiceProperty = interface
    interface IReadOnlyServiceProperty
    interface IReadOnlyPropertyBase
    interface IReadOnlyAnnotatable
    interface IConventionPropertyBase
    interface IConventionAnnotatable
type IConventionServiceProperty = interface
    interface IServiceProperty
    interface IPropertyBase
    interface IAnnotatable
    interface IConventionPropertyBase
    interface IConventionAnnotatable
Public Interface IConventionServiceProperty
Implements IConventionPropertyBase, IReadOnlyServiceProperty
Public Interface IConventionServiceProperty
Implements IConventionPropertyBase, IServiceProperty
実装

注釈

このインターフェイスは、モデルの作成時に使用され、メタデータを変更できます。 モデルが構築されると、 IServiceProperty は同じメタデータの読み取り専用ビューを表します。

詳細と例については、「 モデル構築規則 」を参照してください。

プロパティ

Name 説明
Builder

このサービス プロパティの構成に使用できるビルダーを取得します。

ClrType

このプロパティに似たオブジェクトが保持する値の型を取得します。

(継承元 IPropertyBase)
DeclaringEntityType

このプロパティが属する型を取得します。

DeclaringType

このプロパティに似たオブジェクトが属する型を取得します。

(継承元 IPropertyBase)
FieldInfo

このプロパティに似たオブジェクトの基になる CLR フィールドの FieldInfo を取得します。 これは、シャドウ プロパティまたはバッキング フィールドが不明な場合に null 可能性があります。

(継承元 IPropertyBase)
IsCollection

プロパティがコレクションかどうかを示す値を取得します。

(継承元 IReadOnlyPropertyBase)
IsInModel

このオブジェクトがモデル内にあるかどうか、つまり、モデルから削除されていないかどうかを示します。

(継承元 IConventionAnnotatable)
IsShadowProperty

これがシャドウ プロパティであるかどうかを示す値を取得します。 シャドウ プロパティは、エンティティ クラスに対応するプロパティを持たないプロパティです。 プロパティの現在の値は、エンティティ クラスのインスタンスに格納されるのではなく、 ChangeTracker に格納されます。

(継承元 IPropertyBase)
Item[String]

指定した名前の値注釈を取得し、存在しない場合は null 返します。

(継承元 IAnnotatable)
Name

このプロパティに似たオブジェクトの名前を取得します。

(継承元 IPropertyBase)
ParameterBinding

このプロパティの ServiceParameterBinding 。

(継承元 IServiceProperty)
PropertyInfo

このプロパティに似たオブジェクトの基になる CLR プロパティの PropertyInfo を取得します。 これは、シャドウ プロパティの null 、またはフィールドに直接マップされている場合に使用できます。

(継承元 IPropertyBase)
Sentinel

このプロパティが設定されていないことを示す sentinel 値を取得します。

(継承元 IReadOnlyPropertyBase)

メソッド

Name 説明
AddAnnotation(String, Object, Boolean)

このオブジェクトに注釈を追加します。 指定した名前の注釈が既に存在する場合にスローします。

(継承元 IConventionAnnotatable)
AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean)

オブジェクトに注釈を追加します。

(継承元 IConventionAnnotatable)
AddRuntimeAnnotation(String, Object)

このオブジェクトにランタイム注釈を追加します。 指定した名前の注釈が既に存在する場合にスローします。

(継承元 IAnnotatable)
AnnotationsToDebugString(Int32)

オブジェクトで宣言されているすべての注釈のデバッグ文字列を取得します。

(継承元 IReadOnlyAnnotatable)
FindAnnotation(String)

指定した名前の注釈を取得し、存在しない場合は null 返します。

(継承元 IAnnotatable)
FindRuntimeAnnotation(String)

指定された名前のランタイム注釈を取得し、存在しない場合は null を返します。

(継承元 IAnnotatable)
FindRuntimeAnnotationValue(String)

指定した名前のランタイム注釈の値を取得し、存在しない場合は null 返します。

(継承元 IAnnotatable)
GetAnnotation(String)

指定した名前の注釈を取得し、存在しない場合はスローします。

(継承元 IConventionAnnotatable)
GetAnnotations()

現在のオブジェクトのすべての注釈を取得します。

(継承元 IAnnotatable)
GetCollectionAccessor()

コレクション ナビゲーションまたは複合プロパティの場合は、このプロパティの IClrCollectionAccessor を取得します。

(継承元 IPropertyBase)
GetConfigurationSource()

このプロパティの構成ソースを返します。

GetCurrentValueComparer()

追跡対象のIUpdateEntry エントリの値を比較するためのIComparer<T>を取得します。

(継承元 IPropertyBase)
GetFieldInfoConfigurationSource()

FieldInfoの構成ソースを返します。

(継承元 IConventionPropertyBase)
GetFieldName()

このプロパティのバッキング フィールドの名前を取得します。バッキング フィールドが不明な場合は null します。

(継承元 IReadOnlyPropertyBase)
GetGetter()

このプロパティの値を読み取るための IClrPropertyGetter を取得します。

(継承元 IPropertyBase)
GetIndex()

このプロパティのプロパティ インデックスを取得します。

(継承元 IPropertyBase)
GetMemberInfo(Boolean, Boolean)

指定したプロパティの値を取得または設定するために使用する必要がある PropertyInfo または FieldInfo を取得します。

(継承元 IPropertyBase)
GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg)

指定された名前を持つランタイム注釈の値を取得し、存在しない場合は追加します。

(継承元 IAnnotatable)
GetParameterBindingConfigurationSource()

ParameterBindingの構成ソースを返します。

GetPropertyAccessMode()

このプロパティに使用されている PropertyAccessMode を取得します。 null は、既定のプロパティ アクセス モードが使用されていることを示します。

(継承元 IPropertyBase)
GetPropertyAccessModeConfigurationSource()

GetPropertyAccessMode()の構成ソースを返します。

(継承元 IConventionPropertyBase)
GetRuntimeAnnotations()

現在のオブジェクトのすべてのランタイム注釈を取得します。

(継承元 IAnnotatable)
IsIndexerProperty()

これがインデクサー プロパティであるかどうかを示す値を取得します。 インデクサー プロパティは、エンティティ クラスのインデクサーを介してアクセスされるプロパティです。

(継承元 IReadOnlyPropertyBase)
RemoveAnnotation(String)

指定した名前の注釈をこのオブジェクトから削除します。

(継承元 IConventionAnnotatable)
RemoveRuntimeAnnotation(String)

指定されたランタイム注釈をこのオブジェクトから削除します。

(継承元 IAnnotatable)
SetAnnotation(String, Object, Boolean)

指定した名前の下に格納されている注釈を設定します。 指定した名前の注釈が既に存在する場合は、既存の注釈を上書きします。

(継承元 IConventionAnnotatable)
SetField(FieldInfo, Boolean)
古い.

このプロパティで使用する基になる CLR フィールドの FieldInfo を設定します。

既定では、バッキング フィールドが見つかった場合、または指定されている場合は、新しいオブジェクトが構築されるときに使用されます。通常は、データベースからエンティティが照会されるときに使用されます。 プロパティは、他のすべてのアクセスに使用されます。 これは、 SetPropertyAccessMode(Nullable<PropertyAccessMode>, Boolean)を呼び出すことによって変更できます。

(継承元 IConventionPropertyBase)
SetField(String, Boolean)

このプロパティで使用する基になる CLR フィールドを設定します。 これは、シャドウ プロパティの場合や、プロパティのバッキング フィールドがわからない場合に null 可能性があります。

(継承元 IConventionPropertyBase)
SetFieldInfo(FieldInfo, Boolean)

このプロパティで使用する基になる CLR フィールドの FieldInfo を設定します。

(継承元 IConventionPropertyBase)
SetOrRemoveAnnotation(String, Object, Boolean)

指定した名前の下に格納されている注釈を設定します。 指定した名前の注釈が既に存在する場合は、既存の注釈を上書きします。 nullが指定されている場合は、既存の注釈を削除します。

(継承元 IConventionAnnotatable)
SetParameterBinding(ServiceParameterBinding, Boolean)

このプロパティの ServiceParameterBinding を設定します。

SetPropertyAccessMode(Nullable<PropertyAccessMode>, Boolean)

このプロパティに使用する PropertyAccessMode を設定します。

(継承元 IConventionPropertyBase)
SetRuntimeAnnotation(String, Object)

指定されたキーの下に格納されているランタイム注釈を設定します。 指定した名前の注釈が既に存在する場合は、既存の注釈を上書きします。

(継承元 IAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)

指定されたメタデータの人間が判読できる表現を作成します。

警告: 返される文字列の形式に依存しないでください。 デバッグ専用に設計されており、リリース間で任意に変更される可能性があります。

(継承元 IReadOnlyServiceProperty)

拡張メソッド

Name 説明
AddAnnotations(IConventionAnnotatable, IEnumerable<IConventionAnnotation>, Boolean)

オブジェクトに注釈を追加します。

AnnotationsToDebugString(IAnnotatable, Int32)

オブジェクトで宣言されているすべての注釈のデバッグ文字列を取得します。

GetAnnotation(IAnnotatable, String)

指定した名前の注釈を取得し、存在しない場合はスローします。

GetAnnotation(IConventionAnnotatable, String)

指定した名前の注釈を取得し、存在しない場合はスローします。

GetCurrentValueComparer(IPropertyBase)

追跡対象のIUpdateEntry エントリの値を比較するためのIComparer<T>を取得します。

GetFieldName(IPropertyBase)

このプロパティのバッキング フィールドの名前を取得します。バッキング フィールドが不明な場合は null します。

GetGetter(IPropertyBase)

このプロパティの値を読み取るための IClrPropertyGetter を取得します。

このようなプロパティには関連付けられたMemberInfoがないため、シャドウ プロパティ (IsShadowProperty(IPropertyBase)) に対してこのメソッドを呼び出すとエラーになります。

GetIndex(IPropertyBase)

このプロパティのプロパティ インデックスを取得します。

GetMemberInfo(IPropertyBase, Boolean, Boolean)

指定したプロパティの値を取得または設定するために使用する必要がある PropertyInfo または FieldInfo を取得します。

このようなプロパティには関連付けられたMemberInfoがないため、シャドウ プロパティ (IsShadowProperty(IPropertyBase)) に対してこのメソッドを呼び出すとエラーになります。

GetPropertyAccessMode(IPropertyBase)

このプロパティに使用されている PropertyAccessMode を取得します。 null は、既定のプロパティ アクセス モードが使用されていることを示します。

GetPropertyAccessModeConfigurationSource(IConventionPropertyBase)

GetPropertyAccessMode()の構成ソースを返します。

IsIndexerProperty(IPropertyBase)

これがインデクサー プロパティであるかどうかを示す値を取得します。 インデクサー プロパティは、エンティティ クラスのインデクサーを介してアクセスされるプロパティです。

IsShadowProperty(IPropertyBase)
古い.

これがシャドウ プロパティであるかどうかを示す値を取得します。 シャドウ プロパティは、エンティティ クラスに対応するプロパティを持たないプロパティです。 プロパティの現在の値は、エンティティ クラスのインスタンスに格納されるのではなく、 ChangeTracker に格納されます。

SetField(IConventionPropertyBase, String, Boolean)

このプロパティで使用する基になる CLR フィールドを設定します。 これは、シャドウ プロパティの場合や、プロパティのバッキング フィールドがわからない場合に null 可能性があります。

バッキング フィールドは、通常、次に示すように規則によって見つかります。 http://go.microsoft.com/fwlink/?LinkId=723277. このメソッドは、規則によって正しいフィールドが見つからない場合に、バッキング フィールドを明示的に設定する場合に便利です。

既定では、バッキング フィールドが見つかった場合、または指定されている場合は、新しいオブジェクトが構築されるときに使用されます。通常は、データベースからエンティティが照会されるときに使用されます。 プロパティは、他のすべてのアクセスに使用されます。 これは、 SetPropertyAccessMode(IConventionPropertyBase, Nullable<PropertyAccessMode>, Boolean)を呼び出すことによって変更できます。

SetOrRemoveAnnotation(IConventionAnnotatable, String, Object, Boolean)

指定した名前の下に格納されている注釈を設定します。 指定した名前の注釈が既に存在する場合は、既存の注釈を上書きします。 nullが指定されている場合は、既存の注釈を削除します。

SetPropertyAccessMode(IConventionPropertyBase, Nullable<PropertyAccessMode>, Boolean)

このプロパティに使用する PropertyAccessMode を設定します。

ToDebugString(IServiceProperty, MetadataDebugStringOptions, Int32)

指定されたメタデータの人間が判読できる表現を作成します。

警告: 返される文字列の形式に依存しないでください。 デバッグ専用に設計されており、リリース間で任意に変更される可能性があります。

適用対象