Language

IConventionComplexProperty インターフェイス

定義

構造型の複合プロパティを表します。

public interface IConventionComplexProperty : Microsoft.EntityFrameworkCore.Metadata.IConventionPropertyBase, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyComplexProperty
type IConventionComplexProperty = interface
    interface IReadOnlyComplexProperty
    interface IReadOnlyPropertyBase
    interface IReadOnlyAnnotatable
    interface IConventionPropertyBase
    interface IConventionAnnotatable
Public Interface IConventionComplexProperty
Implements IConventionPropertyBase, IReadOnlyComplexProperty
実装

注釈

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

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

プロパティ

Name 説明
Builder

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

ClrType

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

(継承元 IReadOnlyPropertyBase)
ComplexType

関連付けられている複合型を取得します。

DeclaringType

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

(継承元 IReadOnlyPropertyBase)
FieldInfo

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

(継承元 IReadOnlyPropertyBase)
IsCollection

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

(継承元 IReadOnlyPropertyBase)
IsInModel

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

(継承元 IConventionAnnotatable)
IsNullable

このプロパティに nullを含めることができるかどうかを示す値を取得します。

(継承元 IReadOnlyComplexProperty)
Item[String]

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

(継承元 IReadOnlyAnnotatable)
Name

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

(継承元 IReadOnlyPropertyBase)
PropertyInfo

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

(継承元 IReadOnlyPropertyBase)
Sentinel

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

(継承元 IReadOnlyPropertyBase)

メソッド

Name 説明
AddAnnotation(String, Object, Boolean)

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

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

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

(継承元 IConventionAnnotatable)
AnnotationsToDebugString(Int32)

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

(継承元 IReadOnlyAnnotatable)
FindAnnotation(String)

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

(継承元 IConventionAnnotatable)
GetAnnotation(String)

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

(継承元 IConventionAnnotatable)
GetAnnotations()

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

(継承元 IConventionAnnotatable)
GetConfigurationSource()

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

(継承元 IConventionPropertyBase)
GetFieldInfoConfigurationSource()

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

(継承元 IConventionPropertyBase)
GetFieldName()

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

(継承元 IReadOnlyPropertyBase)
GetIsNullableConfigurationSource()

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

GetPropertyAccessMode()

このプロパティに似たオブジェクトに使用されている PropertyAccessMode を取得します。

(継承元 IReadOnlyPropertyBase)
GetPropertyAccessModeConfigurationSource()

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

(継承元 IConventionPropertyBase)
IsIndexerProperty()

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

(継承元 IReadOnlyPropertyBase)
IsShadowProperty()

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

(継承元 IReadOnlyPropertyBase)
RemoveAnnotation(String)

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

(継承元 IConventionAnnotatable)
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)
SetIsNullable(Nullable<Boolean>, Boolean)

このプロパティに nullを含めることができるかどうかを示す値を設定します。

SetOrRemoveAnnotation(String, Object, Boolean)

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

(継承元 IConventionAnnotatable)
SetPropertyAccessMode(Nullable<PropertyAccessMode>, Boolean)

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

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

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

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

(継承元 IReadOnlyComplexProperty)

拡張メソッド

Name 説明
GetJsonPropertyName(IReadOnlyComplexProperty)

Cosmos を対象とする場合にプロパティがマップされるプロパティ名を返します。

GetJsonPropertyName(IReadOnlyComplexProperty)

JSON 列にマップされたエンティティの指定された複合プロパティに使用される JSON プロパティ名の値を取得します。

GetJsonPropertyNameConfigurationSource(IConventionComplexProperty)

特定の複合プロパティの JSON プロパティ名の ConfigurationSource を取得します。

GetMappedStoreObjects(IReadOnlyComplexProperty, StoreObjectType)

この複合プロパティが JSON 列にマップされている場合にマップされるテーブルに似たストア オブジェクトを返します。

このメソッドは、通常、データベース プロバイダー (およびその他の拡張機能) によって使用されます。 通常、アプリケーション コードでは使用されません。

SetJsonPropertyName(IConventionComplexProperty, String, Boolean)

JSON 列にマップされたエンティティの指定された複合プロパティに使用される JSON プロパティ名の値を設定します。

適用対象