IConventionProperty インターフェイス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
構造型のスカラー プロパティを表します。
public interface IConventionProperty : Microsoft.EntityFrameworkCore.Metadata.IConventionPropertyBase, Microsoft.EntityFrameworkCore.Metadata.IPropertypublic interface IConventionProperty : Microsoft.EntityFrameworkCore.Metadata.IConventionPropertyBase, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyPropertytype IConventionProperty = interface
interface IProperty
interface IPropertyBase
interface IAnnotatable
interface IConventionPropertyBase
interface IConventionAnnotatabletype IConventionProperty = interface
interface IReadOnlyProperty
interface IReadOnlyPropertyBase
interface IReadOnlyAnnotatable
interface IConventionPropertyBase
interface IConventionAnnotatablePublic Interface IConventionProperty
Implements IConventionPropertyBase, IPropertyPublic Interface IConventionProperty
Implements IConventionPropertyBase, IReadOnlyProperty- 実装
注釈
このインターフェイスはモデルの作成時に使用され、メタデータを変更できます。 モデルが構築されると、 IProperty は同じメタデータの読み取り専用ビューを表します。
詳細と例については、「 モデルの構築規則 」を参照してください。
プロパティ
| AfterSaveBehavior |
エンティティがデータベースに保存された後にこのプロパティを変更できるかどうかを示す値を取得します。 の場合 Throw、エンティティがデータベースに存在した後にこのプロパティに新しい値が割り当てられると、例外がスローされます。 の場合 Ignore、データベースに既に存在するエンティティのプロパティ値に対する変更は無視されます。 (継承元 IProperty) |
| BeforeSaveBehavior |
エンティティをデータベースに保存する前に、このプロパティを変更できるかどうかを示す値を取得します。 の場合 Throw、値が状態のときにこのプロパティに値が割り当てられると、例外が Added スローされます。 の場合 Ignore、値セットは状態のときに Added 無視されます。 (継承元 IProperty) |
| Builder |
このプロパティの構成に使用できるビルダーを取得します。 |
| ClrType |
このプロパティに似たオブジェクトが保持する値の型を取得します。 (継承元 IReadOnlyPropertyBase) |
| DeclaringEntityType |
互換性のために残されています。.
このプロパティが属するエンティティ型を取得します。 |
| DeclaringType |
このプロパティに似たオブジェクトが属する型を取得します。 (継承元 IReadOnlyPropertyBase) |
| FieldInfo |
FieldInfoこのプロパティに似たオブジェクトの基になる CLR フィールドの を取得します。
|
| IsConcurrencyToken |
このプロパティがコンカレンシー トークンとして使用されるかどうかを示す値を取得します。 プロパティがコンカレンシー トークンとして構成されている場合、データベースからインスタンスが取得されてから変更されていないことを確認するために、このエンティティ型のインスタンスが更新 SaveChanges() または削除されたときに、データベース内の値がチェックされます。 変更された場合、例外がスローされ、変更はデータベースに適用されません。 (継承元 IReadOnlyProperty) |
| IsInModel |
このオブジェクトがモデル内にあるかどうか、つまり、モデルから削除されていないかどうかを示します。 (継承元 IConventionAnnotatable) |
| IsNullable |
このプロパティに を含 |
| IsPrimitiveCollection |
プロパティが CLR 型の要素型と一致する要素型を持つ場合、プロパティはプリミティブ コレクションです。 (継承元 IReadOnlyProperty) |
| IsReadOnlyAfterSave |
互換性のために残されています。.
このプロパティは今後使用しません。 代わりに、BeforeSaveBehavior を使用してください。 (継承元 IProperty) |
| IsReadOnlyBeforeSave |
互換性のために残されています。.
このプロパティは今後使用しません。 代わりに、BeforeSaveBehavior を使用してください。 (継承元 IProperty) |
| IsStoreGeneratedAlways |
互換性のために残されています。.
このプロパティは今後使用しません。 代わりに、BeforeSaveBehavior タグまたは AfterSaveBehavior タグを使用してください。 (継承元 IProperty) |
| Item[String] |
指定した名前の注釈の値を取得し、存在しない場合は を |
| Name |
このプロパティに似たオブジェクトの名前を取得します。 (継承元 IReadOnlyPropertyBase) |
| PropertyInfo |
PropertyInfoこのプロパティに似たオブジェクトの基になる CLR プロパティの を取得します。
|
| RequiresValueGenerator |
新しいエンティティがコンテキストに追加されたときに、このプロパティで ValueGenerator 値を生成するために が必要かどうかを示す値を取得します。 (継承元 IProperty) |
| Sentinel |
このプロパティが設定されていないことを示す sentinel 値を取得します。 (継承元 IReadOnlyPropertyBase) |
| ValueGenerated |
このプロパティの値がデータベースによって生成されるタイミングを示す値を取得します。 プロパティがデータベースによって生成されるように設定されている場合でも、エンティティが追加され、値が割り当てられている場合、またはプロパティが既存のエンティティに対して変更済みとしてマークされている場合、EF は (データベースによって生成される値ではなく) 特定の値を保存しようとする可能性があります。 詳細とGetAfterSaveBehavior()例についてはGetBeforeSaveBehavior()、 と を参照してください。 (継承元 IReadOnlyProperty) |
メソッド
| AddAnnotation(String, Object, Boolean) |
このオブジェクトに注釈を追加します。 指定した名前の注釈が既に存在する場合は をスローします。 (継承元 IConventionAnnotatable) |
| AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean) |
オブジェクトに注釈を追加します。 (継承元 IConventionAnnotatable) |
| AddRuntimeAnnotation(String, Object) |
このオブジェクトにランタイム注釈を追加します。 指定した名前の注釈が既に存在する場合は をスローします。 (継承元 IAnnotatable) |
| AnnotationsToDebugString(Int32) |
オブジェクトで宣言されているすべての注釈のデバッグ文字列を取得します。 (継承元 IReadOnlyAnnotatable) |
| CreateKeyEqualityComparer<TProperty>() |
指定した IEqualityComparer<T> プロパティ型の値の を作成します。 (継承元 IProperty) |
| FindAnnotation(String) |
指定した名前の注釈を取得し、存在しない場合は を |
| FindContainingPrimaryKey() |
このプロパティを使用する主キー (このプロパティが含まれる複合主キーを含む) を取得します。 |
| FindFirstPrincipal() |
指定したプロパティが外部キーの一部である場合に、指定されたプロパティが制約される最初のプリンシパル プロパティを検索します。 |
| FindRuntimeAnnotation(String) |
指定された名前のランタイム注釈を取得し、存在しない場合は を |
| FindRuntimeAnnotationValue(String) |
指定された名前のランタイム注釈の値を取得し、存在しない場合は を |
| FindTypeMapping() |
このプロパティの型マッピングを返します。 (継承元 IReadOnlyProperty) |
| GetAfterSaveBehavior() |
エンティティがデータベースに保存された後にこのプロパティを変更できるかどうかを示す値を取得します。 (継承元 IReadOnlyProperty) |
| GetAfterSaveBehaviorConfigurationSource() |
の構成ソースを GetAfterSaveBehavior()返します。 |
| GetAnnotation(String) |
指定した名前の注釈を取得し、存在しない場合は をスローします。 (継承元 IReadOnlyAnnotatable) |
| GetAnnotations() |
現在の オブジェクトのすべての注釈を取得します。 (継承元 IReadOnlyAnnotatable) |
| GetBeforeSaveBehavior() |
エンティティをデータベースに保存する前に、このプロパティを変更できるかどうかを示す値を取得します。 (継承元 IReadOnlyProperty) |
| GetBeforeSaveBehaviorConfigurationSource() |
の構成ソースを GetBeforeSaveBehavior()返します。 |
| GetConfigurationSource() |
このプロパティの構成ソースを返します。 |
| GetContainingForeignKeys() |
このプロパティを使用するすべての外部キー (このプロパティが含まれる複合外部キーを含む) を取得します。 |
| GetContainingIndexes() |
このプロパティを使用するすべてのインデックス (このプロパティが含まれる複合インデックスを含む) を取得します。 |
| GetContainingKeys() |
このプロパティを使用するすべての主キーまたは代替キー (このプロパティが含まれる複合キーを含む) を取得します。 |
| GetCurrentValueComparer() |
IComparer<T>追跡対象IUpdateEntryエントリの値を比較するための を取得します。 (継承元 IPropertyBase) |
| GetElementType() |
このプロパティで表されるプリミティブ コレクションの要素の構成を取得します。 |
| GetElementTypeConfigurationSource() |
の構成ソースを GetElementType()返します。 |
| GetFieldInfoConfigurationSource() |
の構成ソースを FieldInfo返します。 (継承元 IConventionPropertyBase) |
| GetFieldName() |
このプロパティのバッキング フィールドの名前を取得します。バ |
| GetGetter() |
このプロパティの IClrPropertyGetter 値を読み取るための を取得します。 (継承元 IPropertyBase) |
| GetIndex() |
このプロパティのプロパティ インデックスを取得します。 (継承元 IPropertyBase) |
| GetIsConcurrencyTokenConfigurationSource() |
の構成ソースを IsConcurrencyToken返します。 |
| GetIsNullableConfigurationSource() |
の構成ソースを IsNullable返します。 |
| GetIsUnicodeConfigurationSource() |
の構成ソースを IsUnicode()返します。 |
| GetJsonValueReaderWriter() |
このプロパティの を JsonValueReaderWriter 取得します |
| GetJsonValueReaderWriterTypeConfigurationSource() |
の構成ソースを GetJsonValueReaderWriter()返します。 |
| GetKeyValueComparer() |
このプロパティの ValueComparer キーで使用する を取得します |
| GetMaxLength() |
このプロパティで許可されているデータの最大長を取得します。 たとえば、 プロパティが の String 場合、これは最大文字数です。 (継承元 IReadOnlyProperty) |
| GetMaxLengthConfigurationSource() |
の構成ソースを GetMaxLength()返します。 |
| GetMemberInfo(Boolean, Boolean) |
指定したプロパティの値をPropertyInfoFieldInfo取得または設定するために使用する または を取得します。 (継承元 IPropertyBase) |
| GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg) |
指定された名前のランタイム注釈の値を取得し、存在しない場合は追加します。 (継承元 IAnnotatable) |
| GetPrecision() |
このプロパティで許可されているデータの有効桁数を取得します。 たとえば、 プロパティが の Decimal 場合、これは最大桁数です。 (継承元 IReadOnlyProperty) |
| GetPrecisionConfigurationSource() |
の構成ソースを GetPrecision()返します。 |
| GetPrincipals() |
指定したプロパティが外部キーの一部である場合に、指定されたプロパティが制約される特定のプロパティを含むプリンシパル プロパティの一覧を検索します。 |
| GetPrincipals<T>() |
指定したプロパティが外部キーの一部である場合に、指定されたプロパティが制約される特定のプロパティを含むプリンシパル プロパティの一覧を検索します。 (継承元 IReadOnlyProperty) |
| GetPropertyAccessMode() |
PropertyAccessModeこのプロパティに似たオブジェクトに使用されている を取得します。 (継承元 IReadOnlyPropertyBase) |
| GetPropertyAccessModeConfigurationSource() |
の構成ソースを GetPropertyAccessMode()返します。 (継承元 IConventionPropertyBase) |
| GetProviderClrType() |
データベース プロバイダーに送信される前にプロパティ値が変換される型を取得します。 (継承元 IReadOnlyProperty) |
| GetProviderClrTypeConfigurationSource() |
の構成ソースを GetProviderClrType()返します。 |
| GetProviderValueComparer() |
このプロパティの ValueComparer プロバイダー値に使用する を取得します。 (継承元 IReadOnlyProperty) |
| GetProviderValueComparerConfigurationSource() |
の構成ソースを GetProviderValueComparer()返します。 |
| GetRuntimeAnnotations() |
現在の オブジェクトのすべてのランタイム注釈を取得します。 (継承元 IAnnotatable) |
| GetScale() |
このプロパティで許可されているデータのスケールを取得します。 たとえば、 プロパティが の Decimal 場合、これは小数点以下の桁数の最大数です。 (継承元 IReadOnlyProperty) |
| GetScaleConfigurationSource() |
の構成ソースを GetScale()返します。 |
| GetSentinelConfigurationSource() |
の構成ソースを Sentinel返します。 |
| GetTypeConfigurationSource() |
の構成ソースを ClrType返します。 |
| GetTypeMapping() |
CoreTypeMapping完成したモデルから、指定されたプロパティの を返します。 (継承元 IReadOnlyProperty) |
| GetTypeMappingConfigurationSource() |
プロパティの ConfigurationSource の CoreTypeMapping を取得します。 |
| GetValueComparer() |
このプロパティの を ValueComparer 取得します |
| GetValueComparerConfigurationSource() |
の構成ソースを GetValueComparer()返します。 |
| GetValueConverter() |
このプロパティのカスタム ValueConverter セットを取得します。 (継承元 IReadOnlyProperty) |
| GetValueConverterConfigurationSource() |
の構成ソースを GetValueConverter()返します。 |
| GetValueGeneratedConfigurationSource() |
の構成ソースを ValueGenerated返します。 |
| GetValueGeneratorFactory() |
このプロパティの値を生成するように設定されているファクトリ (存在する場合) を取得します。 (継承元 IReadOnlyProperty) |
| GetValueGeneratorFactoryConfigurationSource() |
の構成ソースを GetValueGeneratorFactory()返します。 |
| IsForeignKey() |
このプロパティが外部キー (または複合外部キーの一部) として使用されるかどうかを示す値を取得します。 (継承元 IReadOnlyProperty) |
| IsImplicitlyCreated() |
プロパティが暗黙的に作成され、CLR モデルに基づいていないかどうかを示す値を返します。 |
| IsIndex() |
このプロパティがインデックス (または複合インデックスの一部) として使用されるかどうかを示す値を取得します。 (継承元 IReadOnlyProperty) |
| IsIndexerProperty() |
これがインデクサー プロパティであるかどうかを示す値を取得します。 インデクサー プロパティは、エンティティ クラスのインデクサーを介してアクセスされるプロパティです。 (継承元 IReadOnlyPropertyBase) |
| IsKey() |
このプロパティを主キーまたは代替キー (または複合主キーまたは代替キーの一部) として使用するかどうかを示す値を取得します。 (継承元 IReadOnlyProperty) |
| IsPrimaryKey() |
このプロパティを主キー (または複合主キーの一部) として使用するかどうかを示す値を取得します。 (継承元 IReadOnlyProperty) |
| IsShadowProperty() |
これがシャドウ プロパティであるかどうかを示す値を取得します。 シャドウ プロパティは、エンティティ クラスに対応するプロパティを持たないプロパティです。 プロパティの現在の値は、エンティティ クラスのインスタンスに ChangeTracker 格納されるのではなく、 に格納されます。 (継承元 IReadOnlyPropertyBase) |
| IsUnicode() |
プロパティが Unicode 文字を保持できるかどうかを示す値を取得します。 (継承元 IReadOnlyProperty) |
| IsUniqueIndex() |
このプロパティを一意のインデックス (または一意の複合インデックスの一部) として使用するかどうかを示す値を取得します。 (継承元 IReadOnlyProperty) |
| RemoveAnnotation(String) |
指定した名前の注釈をこのオブジェクトから削除します。 (継承元 IConventionAnnotatable) |
| RemoveRuntimeAnnotation(String) |
指定されたランタイム注釈をこのオブジェクトから削除します。 (継承元 IAnnotatable) |
| SetAfterSaveBehavior(Nullable<PropertySaveBehavior>, Boolean) |
エンティティがデータベースに保存された後にこのプロパティを変更できるかどうかを示す値を設定します。 |
| SetAnnotation(String, Object, Boolean) |
指定した名前の下に格納されている注釈を設定します。 指定した名前の注釈が既に存在する場合は、既存の注釈を上書きします。 (継承元 IConventionAnnotatable) |
| SetBeforeSaveBehavior(Nullable<PropertySaveBehavior>, Boolean) |
エンティティをデータベースに保存する前に、このプロパティを変更できるかどうかを示す値を設定します。 |
| SetElementType(Type, Boolean) |
このプロパティで表されるプリミティブ コレクションの要素の構成を設定します。 |
| SetField(FieldInfo, Boolean) |
互換性のために残されています。.
このプロパティで FieldInfo 使用する基になる CLR フィールドの を設定します。 既定では、バッキング フィールドが見つかった場合、または指定されている場合は、新しいオブジェクトが構築されるときに使用されます。通常は、データベースからエンティティが照会されるときに使用されます。 プロパティは、他のすべてのアクセスに使用されます。 これは、 を呼び出 SetPropertyAccessMode(Nullable<PropertyAccessMode>, Boolean)すことによって変更できます。 (継承元 IConventionPropertyBase) |
| SetField(String, Boolean) |
このプロパティで使用する基になる CLR フィールドを設定します。
|
| SetFieldInfo(FieldInfo, Boolean) |
このプロパティで FieldInfo 使用する基になる CLR フィールドの を設定します。 (継承元 IConventionPropertyBase) |
| SetIsConcurrencyToken(Nullable<Boolean>, Boolean) |
このプロパティをコンカレンシー トークンとして使用するかどうかを示す値を設定します。 プロパティがコンカレンシー トークンとして構成されている場合、データベースからインスタンスが取得されてから変更されていないことを確認するために、このエンティティ型のインスタンスが更新 SaveChanges() または削除されたときに、データベース内の値がチェックされます。 変更された場合、例外がスローされ、変更はデータベースに適用されません。 |
| SetIsNullable(Nullable<Boolean>, Boolean) |
このプロパティに を含 |
| SetIsUnicode(Nullable<Boolean>, Boolean) |
このプロパティが Unicode 文字を保持できるかどうかを示す値を設定します。 |
| SetJsonValueReaderWriterType(Type, Boolean) |
このプロパティに使用する の JsonValueReaderWriter<TValue> 型を設定します。 |
| SetMaxLength(Nullable<Int32>, Boolean) |
このプロパティで許可されるデータの最大長を設定します。 たとえば、 プロパティが String ' の場合、これは最大文字数です。 |
| SetOrRemoveAnnotation(String, Object, Boolean) |
指定した名前の下に格納されている注釈を設定します。 指定した名前の注釈が既に存在する場合は、既存の注釈を上書きします。 が指定されている場合 |
| SetPrecision(Nullable<Int32>, Boolean) |
このプロパティで許可されるデータの有効桁数を設定します。 たとえば、 プロパティが の Decimal 場合、これは最大桁数です。 |
| SetPropertyAccessMode(Nullable<PropertyAccessMode>, Boolean) |
このプロパティに PropertyAccessMode 使用する を設定します。 (継承元 IConventionPropertyBase) |
| SetProviderClrType(Type, Boolean) |
プロパティ値がデータベース プロバイダーに送信される前に変換される型を設定します。 |
| SetProviderValueComparer(Type, Boolean) |
このプロパティのプロバイダー値に使用するカスタム ValueComparer を設定します。 |
| SetProviderValueComparer(ValueComparer, Boolean) |
このプロパティのプロバイダー値に使用するカスタム ValueComparer を設定します。 |
| SetRuntimeAnnotation(String, Object) |
指定したキーの下に格納されているランタイム注釈を設定します。 指定した名前の注釈が既に存在する場合は、既存の注釈を上書きします。 (継承元 IAnnotatable) |
| SetScale(Nullable<Int32>, Boolean) |
このプロパティで許可されるデータのスケールを設定します。 たとえば、 プロパティが の Decimal 場合、これは小数点以下の桁数の最大数です。 |
| SetSentinel(Object, Boolean) |
このプロパティが設定されていないことを示す sentinel 値を設定します。 |
| SetTypeMapping(CoreTypeMapping, Boolean) |
指定したプロパティの を設定します。CoreTypeMapping |
| SetValueComparer(Type, Boolean) |
このプロパティのカスタム ValueComparer を設定します。 |
| SetValueComparer(ValueComparer, Boolean) |
このプロパティのカスタム ValueComparer を設定します。 |
| SetValueConverter(Type, Boolean) |
このプロパティのカスタム ValueConverter を設定します。 |
| SetValueConverter(ValueConverter, Boolean) |
このプロパティのカスタム ValueConverter を設定します。 |
| SetValueGenerated(Nullable<ValueGenerated>, Boolean) |
このプロパティの値がデータベースによって生成されるタイミングを示す値を設定します。 プロパティがデータベースによって生成されるように設定されている場合でも、エンティティが追加され、値が割り当てられている場合、またはプロパティが既存のエンティティに対して変更済みとしてマークされている場合、EF は (データベースによって生成される値ではなく) 特定の値を保存しようとする可能性があります。 詳細とGetAfterSaveBehavior()例についてはGetBeforeSaveBehavior()、 と を参照してください。 |
| SetValueGeneratorFactory(Func<IProperty,IEntityType,ValueGenerator>, Boolean) |
このプロパティの値の生成に使用するファクトリを設定するか |
| SetValueGeneratorFactory(Func<IProperty,ITypeBase,ValueGenerator>, Boolean) |
このプロパティの値の生成に使用するファクトリを設定するか |
| SetValueGeneratorFactory(Type, Boolean) |
このプロパティの値の生成に使用するファクトリを設定するか |
| ToDebugString(MetadataDebugStringOptions, Int32) |
指定されたメタデータの人間が判読できる表現を作成します。 警告: 返される文字列の形式に依存しないでください。 デバッグ専用に設計されており、リリース間で任意に変更される可能性があります。 (継承元 IReadOnlyProperty) |
明示的なインターフェイスの実装
| IPropertyBase.GetPropertyAccessMode() |
このプロパティに PropertyAccessMode 使用されている を取得します。
|
| IReadOnlyProperty.GetElementType() |
このプロパティで表されるプリミティブ コレクションの要素の構成を取得します。 |
拡張メソッド
適用対象
Entity Framework