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