IProperty インターフェイス

定義

名前空間:

Microsoft.EntityFrameworkCore.Metadata

アセンブリ:

Microsoft.EntityFrameworkCore.dll

パッケージ:

Microsoft.EntityFrameworkCore v8.0.0

構造型のスカラー プロパティを表します。

public interface IProperty : Microsoft.EntityFrameworkCore.Metadata.IPropertyBase, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyProperty

type IProperty = interface
    interface IReadOnlyProperty
    interface IReadOnlyPropertyBase
    interface IReadOnlyAnnotatable
    interface IPropertyBase
    interface IAnnotatable

Public Interface IProperty
Implements IPropertyBase, IReadOnlyProperty

派生

Microsoft.EntityFrameworkCore.Metadata.RuntimeProperty

実装

IAnnotatable IPropertyBase IReadOnlyAnnotatable IReadOnlyProperty IReadOnlyPropertyBase

注釈

詳細と例については、「 エンティティ型とリレーションシップのモデル 化」を参照してください。

プロパティ

DeclaringEntityType	互換性のために残されています。. このプロパティが属するエンティティ型を取得します。
DeclaringType	このプロパティに似たオブジェクトが属する型を取得します。 (継承元 IReadOnlyPropertyBase)
FieldInfo	FieldInfoこのプロパティに似たオブジェクトの基になる CLR フィールドの を取得します。 nullこれは、シャドウ プロパティの場合や、バッキング フィールドが不明な場合に使用できます。 (継承元 IReadOnlyPropertyBase)
IsPrimitiveCollection	プロパティが CLR 型の要素型と一致する要素型を持つ場合、プロパティはプリミティブ コレクションです。 (継承元 IReadOnlyProperty)
Item[String]	指定した名前の注釈の値を取得し、存在しない場合は を null 返します。 (継承元 IReadOnlyAnnotatable)
Name	このプロパティに似たオブジェクトの名前を取得します。 (継承元 IReadOnlyPropertyBase)
PropertyInfo	PropertyInfoこのプロパティに似たオブジェクトの基になる CLR プロパティの を取得します。 nullこれは、シャドウ プロパティの場合や、フィールドに直接マップされている場合に使用できます。 (継承元 IReadOnlyPropertyBase)
Sentinel	このプロパティが設定されていないことを示す sentinel 値を取得します。 (継承元 IReadOnlyPropertyBase)

メソッド

AddRuntimeAnnotation(String, Object)	このオブジェクトにランタイム注釈を追加します。 指定した名前の注釈が既に存在する場合は をスローします。 (継承元 IAnnotatable)
AnnotationsToDebugString(Int32)	オブジェクトで宣言されているすべての注釈のデバッグ文字列を取得します。 (継承元 IReadOnlyAnnotatable)
CreateKeyEqualityComparer<TProperty>()	指定した IEqualityComparer<T> プロパティ型の値の を作成します。
FindAnnotation(String)	指定した名前の注釈を取得し、存在しない場合は を null 返します。 (継承元 IReadOnlyAnnotatable)
FindContainingPrimaryKey()	このプロパティを使用する主キー (このプロパティが含まれる複合主キーを含む) を取得します。
FindFirstPrincipal()	指定したプロパティが外部キーの一部である場合に、指定されたプロパティが制約される最初のプリンシパル プロパティを検索します。
FindRuntimeAnnotation(String)	指定された名前のランタイム注釈を取得し、存在しない場合は を null 返します。 (継承元 IAnnotatable)
FindRuntimeAnnotationValue(String)	指定された名前のランタイム注釈の値を取得し、存在しない場合は を null 返します。 (継承元 IAnnotatable)
FindTypeMapping()	このプロパティの型マッピングを返します。 (継承元 IReadOnlyProperty)
GetAfterSaveBehavior()	エンティティがデータベースに保存された後にこのプロパティを変更できるかどうかを示す値を取得します。 (継承元 IReadOnlyProperty)
GetAnnotation(String)	指定した名前の注釈を取得し、存在しない場合は をスローします。 (継承元 IReadOnlyAnnotatable)
GetAnnotations()	現在の オブジェクトのすべての注釈を取得します。 (継承元 IReadOnlyAnnotatable)
GetBeforeSaveBehavior()	エンティティをデータベースに保存する前に、このプロパティを変更できるかどうかを示す値を取得します。 (継承元 IReadOnlyProperty)
GetContainingForeignKeys()	このプロパティを使用するすべての外部キー (このプロパティが含まれる複合外部キーを含む) を取得します。
GetContainingIndexes()	このプロパティを使用するすべてのインデックス (このプロパティが含まれる複合インデックスを含む) を取得します。
GetContainingKeys()	このプロパティを使用するすべての主キーまたは代替キー (このプロパティが含まれる複合キーを含む) を取得します。
GetCurrentValueComparer()	IComparer<T>追跡対象IUpdateEntryエントリの値を比較するための を取得します。 (継承元 IPropertyBase)
GetElementType()	このプロパティで表されるプリミティブ コレクションの要素の構成を取得します。
GetFieldName()	このプロパティのバッキング フィールドの名前を取得します。バ null ッキング フィールドが不明な場合は を取得します。 (継承元 IReadOnlyPropertyBase)
GetGetter()	このプロパティの IClrPropertyGetter 値を読み取るための を取得します。 (継承元 IPropertyBase)
GetIndex()	このプロパティのプロパティ インデックスを取得します。 (継承元 IPropertyBase)
GetJsonValueReaderWriter()	このプロパティの を JsonValueReaderWriter 取得します null 。何も設定されていない場合は を取得します。 (継承元 IReadOnlyProperty)
GetKeyValueComparer()	このプロパティの ValueComparer キーで使用する を取得します。
GetMaxLength()	このプロパティで許可されているデータの最大長を取得します。 たとえば、 プロパティが の String 場合、これは最大文字数です。 (継承元 IReadOnlyProperty)
GetMemberInfo(Boolean, Boolean)	指定したプロパティの値をPropertyInfoFieldInfo取得または設定するために使用する または を取得します。 (継承元 IPropertyBase)
GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg)	指定された名前のランタイム注釈の値を取得し、存在しない場合は追加します。 (継承元 IAnnotatable)
GetPrecision()	このプロパティで許可されているデータの有効桁数を取得します。 たとえば、 プロパティが の Decimal 場合、これは最大桁数です。 (継承元 IReadOnlyProperty)
GetPrincipals()	指定したプロパティが外部キーの一部である場合に、指定されたプロパティが制約される特定のプロパティを含むプリンシパル プロパティの一覧を検索します。
GetPrincipals<T>()	指定したプロパティが外部キーの一部である場合に、指定されたプロパティが制約される特定のプロパティを含むプリンシパル プロパティの一覧を検索します。 (継承元 IReadOnlyProperty)
GetPropertyAccessMode()	PropertyAccessModeこのプロパティに似たオブジェクトに使用されている を取得します。 (継承元 IReadOnlyPropertyBase)
GetProviderClrType()	データベース プロバイダーに送信される前にプロパティ値が変換される型を取得します。 (継承元 IReadOnlyProperty)
GetProviderValueComparer()	このプロパティの ValueComparer プロバイダー値に使用する を取得します。
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)
IsUnicode()	プロパティが Unicode 文字を保持できるかどうかを示す値を取得します。 (継承元 IReadOnlyProperty)
IsUniqueIndex()	このプロパティを一意のインデックス (または一意の複合インデックスの一部) として使用するかどうかを示す値を取得します。 (継承元 IReadOnlyProperty)
RemoveRuntimeAnnotation(String)	指定されたランタイム注釈をこのオブジェクトから削除します。 (継承元 IAnnotatable)
SetRuntimeAnnotation(String, Object)	指定したキーの下に格納されているランタイム注釈を設定します。 指定した名前の注釈が既に存在する場合は、既存の注釈を上書きします。 (継承元 IAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)	指定されたメタデータの人間が判読できる表現を作成します。 警告: 返される文字列の形式に依存しないでください。 デバッグ専用に設計されており、リリース間で任意に変更される可能性があります。 (継承元 IReadOnlyProperty)

拡張メソッド

GetJsonPropertyName(IReadOnlyProperty)	Cosmos を対象とする場合にプロパティがマップされるプロパティ名を返します。
FindColumn(IProperty, StoreObjectIdentifier)	指定したテーブルに似たストア オブジェクトにマップされている場合は、このプロパティに対応する列を返します。
FindOverrides(IProperty, StoreObjectIdentifier)	特定のテーブルに似たストア オブジェクトのプロパティ ファセットオーバーライドを返します。 このメソッドは、通常、データベース プロバイダー (およびその他の拡張機能) によって使用されます。 通常、アプリケーション コードでは使用されません。
FindOverrides(IReadOnlyProperty, StoreObjectIdentifier)	特定のテーブルに似たストア オブジェクトのプロパティ ファセットオーバーライドを返します。 このメソッドは、通常、データベース プロバイダー (およびその他の拡張機能) によって使用されます。 通常、アプリケーション コードでは使用されません。
FindRelationalTypeMapping(IReadOnlyProperty)	最終処理されたモデルの RelationalTypeMapping 指定されたプロパティの を返します。
FindRelationalTypeMapping(IReadOnlyProperty, StoreObjectIdentifier)	最終処理されたモデルの RelationalTypeMapping 指定されたプロパティの を返します。
FindSharedStoreObjectRootProperty(IProperty, StoreObjectIdentifier)	共有テーブルに似たオブジェクト内の同じ列にマップされている最初 IProperty の 列を検索します。 このメソッドは、通常、データベース プロバイダー (およびその他の拡張機能) によって使用されます。 通常、アプリケーション コードでは使用されません。
FindSharedStoreObjectRootProperty(IReadOnlyProperty, StoreObjectIdentifier)	共有テーブルに似たオブジェクト内の同じ列にマップされている最初 IProperty の 列を検索します。 このメソッドは、通常、データベース プロバイダー (およびその他の拡張機能) によって使用されます。 通常、アプリケーション コードでは使用されません。
GetCollation(IReadOnlyProperty)	列に使用する照合順序を返します。
GetCollation(IReadOnlyProperty, StoreObjectIdentifier)	列に使用する照合順序を返します。
GetColumnBaseName(IReadOnlyProperty)	互換性のために残されています。. プロパティのマップ先となる列のベース名を返します。
GetColumnName(IReadOnlyProperty)	プロパティのマップ先となる列の名前を返します。
GetColumnName(IReadOnlyProperty, StoreObjectIdentifier)	プロパティが特定のテーブルにマップされる列の名前を返します。
GetColumnOrder(IReadOnlyProperty)	このプロパティがマップされる列の順序を返します。
GetColumnOrder(IReadOnlyProperty, StoreObjectIdentifier)	このプロパティが特定のテーブルにマップされる列の順序を返します。
GetColumnType(IProperty)	プロパティがマップされる列のデータベース型を返します。
GetColumnType(IProperty, StoreObjectIdentifier)	プロパティがマップされる列のデータベース型を返します。
GetColumnType(IReadOnlyProperty)	プロパティがマップされている列のデータベース型を返します。または null 、データベースの種類が見つからなかった場合は を返します。
GetColumnType(IReadOnlyProperty, StoreObjectIdentifier)	プロパティがマップされている列のデータベース型を返します。または null 、データベースの種類が見つからなかった場合は を返します。
GetComment(IReadOnlyProperty)	このプロパティがマップされる列のコメントを返します。
GetComment(IReadOnlyProperty, StoreObjectIdentifier)	このプロパティがマップされる列のコメントを返します。
GetComputedColumnSql(IReadOnlyProperty)	このプロパティがマップされる列の計算値として使用される SQL 式を返します。
GetComputedColumnSql(IReadOnlyProperty, StoreObjectIdentifier)	このプロパティがマップされる列の計算値として使用される SQL 式を返します。
GetDefaultColumnBaseName(IReadOnlyProperty)	互換性のために残されています。. プロパティのマップ先となる列の既定のベース名を返します。
GetDefaultColumnMappings(IProperty)	プロパティのマップ先となる既定の列を返します。
GetDefaultColumnName(IReadOnlyProperty)	プロパティのマップ先となる列の既定のベース名を返します。
GetDefaultColumnName(IReadOnlyProperty, StoreObjectIdentifier)	プロパティのマップ先となる既定の列名を返します。
GetDefaultValue(IReadOnlyProperty)	このプロパティがマップされる列の既定値として使用される オブジェクトを返します。
GetDefaultValue(IReadOnlyProperty, StoreObjectIdentifier)	このプロパティがマップされる列の既定値として使用される オブジェクトを返します。
GetDefaultValueSql(IReadOnlyProperty)	このプロパティがマップされる列の既定値として使用される SQL 式を返します。
GetDefaultValueSql(IReadOnlyProperty, StoreObjectIdentifier)	このプロパティがマップされる列の既定値として使用される SQL 式を返します。
GetDeleteStoredProcedureParameterMappings(IProperty)	プロパティがマップされるストアド プロシージャの削除パラメーターを返します。
GetFunctionColumnMappings(IProperty)	プロパティがマップされる関数列を返します。
GetInsertStoredProcedureParameterMappings(IProperty)	プロパティがマップされるストアド プロシージャの挿入パラメーターを返します。
GetInsertStoredProcedureResultColumnMappings(IProperty)	プロパティがマップされるストアド プロシージャの挿入結果列を返します。
GetIsStored(IReadOnlyProperty)	このプロパティがマップされる計算列の値がデータベースに格納されるか、読み取られたときに計算されるかを取得します。
GetIsStored(IReadOnlyProperty, StoreObjectIdentifier)	このプロパティがマップされる計算列の値がデータベースに格納されるか、読み取られたときに計算されるかを取得します。
GetJsonPropertyName(IReadOnlyProperty)	JSON 列にマップされたエンティティの指定されたプロパティに使用される JSON プロパティ名の値を取得します。
GetMappedStoreObjects(IReadOnlyProperty, StoreObjectType)	このプロパティがマップされるテーブルに似たストア オブジェクトを返します。 このメソッドは、通常、データベース プロバイダー (およびその他の拡張機能) によって使用されます。 通常、アプリケーション コードでは使用されません。
GetMaxLength(IReadOnlyProperty, StoreObjectIdentifier)	このプロパティで許可されるデータの最大長を取得します。 たとえば、 プロパティが の String 場合、これは最大文字数です。
GetOverrides(IProperty)	すべてのプロパティ ファセットのオーバーライドを返します。 このメソッドは、通常、データベース プロバイダー (およびその他の拡張機能) によって使用されます。 通常、アプリケーション コードでは使用されません。
GetOverrides(IReadOnlyProperty)	すべてのプロパティ ファセットのオーバーライドを返します。 このメソッドは、通常、データベース プロバイダー (およびその他の拡張機能) によって使用されます。 通常、アプリケーション コードでは使用されません。
GetPrecision(IReadOnlyProperty, StoreObjectIdentifier)	このプロパティで許可されているデータの有効桁数を取得します。 たとえば、 プロパティが の Decimal 場合、これは最大桁数です。
GetReaderFieldValue(IProperty, RelationalDataReader, Int32, Boolean)	指定 relationalReaderした からこのプロパティの値を読み取ります。
GetRelationalTypeMapping(IReadOnlyProperty)	完成したモデルの RelationalTypeMapping 指定されたプロパティの を返します。
GetScale(IReadOnlyProperty, StoreObjectIdentifier)	このプロパティで許可されているデータのスケールを取得します。 たとえば、 プロパティが の Decimal 場合、これは小数点以下の桁数の最大数です。
GetSqlQueryColumnMappings(IProperty)	プロパティがマップされる SQL クエリ列を返します。
GetTableColumnMappings(IProperty)	プロパティがマップされるテーブル列を返します。
GetUpdateStoredProcedureParameterMappings(IProperty)	プロパティがマップされるストアド プロシージャの更新パラメーターを返します。
GetUpdateStoredProcedureResultColumnMappings(IProperty)	プロパティがマップされるストアド プロシージャの更新結果列を返します。
GetViewColumnMappings(IProperty)	プロパティがマップされるビュー列を返します。
IsColumnNullable(IReadOnlyProperty)	指定された に IProperty マップされた列が、データベースで作成されたときに null 許容かどうかを確認します。
IsColumnNullable(IReadOnlyProperty, StoreObjectIdentifier)	データベースで作成するときに、指定されたプロパティにマップされた列が null 許容かどうかを確認します。
IsFixedLength(IReadOnlyProperty)	プロパティが文字列などの固定長データのみを格納できるかどうかを示すフラグを返します。
IsFixedLength(IReadOnlyProperty, StoreObjectIdentifier)	プロパティが文字列などの固定長データのみを格納できるかどうかを示すフラグを返します。
IsUnicode(IReadOnlyProperty, StoreObjectIdentifier)	プロパティが Unicode 文字を保持できるかどうかを示す値を取得します。
TryGetDefaultValue(IReadOnlyProperty, StoreObjectIdentifier, Object)	このプロパティがマップされる列の既定値として使用される オブジェクトを返します。
TryGetDefaultValue(IReadOnlyProperty, Object)	このプロパティがマップされる列の既定値として使用される オブジェクトを返します。
GetDataAnnotations(IProperty, IAnnotationCodeGenerator)	プロパティを構成するためのデータ注釈を取得します。
GetFluentApiCalls(IProperty, IAnnotationCodeGenerator)	プロパティを構成するための fluent API 呼び出しを取得します。
GetSrid(IReadOnlyProperty)	このプロパティの列を作成するときに使用する SRID を返します。
GetSrid(IReadOnlyProperty, StoreObjectIdentifier)	このプロパティの列を作成するときに使用する SRID を返します。
FindHiLoSequence(IProperty)	ISequence hi-lo パターンに使用するモデル内の を検索します。
FindHiLoSequence(IProperty, StoreObjectIdentifier)	ISequence hi-lo パターンに使用するモデル内の を検索します。
FindHiLoSequence(IReadOnlyProperty)	ISequence hi-lo パターンに使用するモデル内の を検索します。
FindHiLoSequence(IReadOnlyProperty, StoreObjectIdentifier)	ISequence hi-lo パターンに使用するモデル内の を検索します。
FindSequence(IProperty)	キー値生成 ISequence パターンに使用するモデル内の を検索します。
FindSequence(IProperty, StoreObjectIdentifier)	キー値生成 ISequence パターンに使用するモデル内の を検索します。
FindSequence(IReadOnlyProperty)	キー値生成 ISequence パターンに使用するモデル内の を検索します。
FindSequence(IReadOnlyProperty, StoreObjectIdentifier)	キー値生成 ISequence パターンに使用するモデル内の を検索します。
GetHiLoSequenceName(IReadOnlyProperty)	hi-lo シーケンスに使用する名前を返します。
GetHiLoSequenceName(IReadOnlyProperty, StoreObjectIdentifier)	hi-lo シーケンスに使用する名前を返します。
GetHiLoSequenceSchema(IReadOnlyProperty)	hi-lo シーケンスに使用するスキーマを返します。
GetHiLoSequenceSchema(IReadOnlyProperty, StoreObjectIdentifier)	hi-lo シーケンスに使用するスキーマを返します。
GetIdentityIncrement(IReadOnlyProperty)	ID の増分を返します。
GetIdentityIncrement(IReadOnlyProperty, StoreObjectIdentifier)	ID の増分を返します。
GetIdentitySeed(IReadOnlyProperty)	ID シードを返します。
GetIdentitySeed(IReadOnlyProperty, StoreObjectIdentifier)	ID シードを返します。
GetSequenceName(IReadOnlyProperty)	キー値の生成シーケンスに使用する名前を返します。
GetSequenceName(IReadOnlyProperty, StoreObjectIdentifier)	キー値の生成シーケンスに使用する名前を返します。
GetSequenceSchema(IReadOnlyProperty)	キー値生成シーケンスに使用するスキーマを返します。
GetSequenceSchema(IReadOnlyProperty, StoreObjectIdentifier)	キー値生成シーケンスに使用するスキーマを返します。
GetValueGenerationStrategy(IReadOnlyProperty)	プロパティに SqlServerValueGenerationStrategy 使用する を返します。
GetValueGenerationStrategy(IReadOnlyProperty, StoreObjectIdentifier)	プロパティに SqlServerValueGenerationStrategy 使用する を返します。
IsSparse(IReadOnlyProperty)	プロパティの列がスパースかどうかを示す値を返します。
IsSparse(IReadOnlyProperty, StoreObjectIdentifier)	プロパティの列がスパースかどうかを示す値を返します。