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)	傳回特定類似資料表之存放區物件的屬性 Facet 覆寫。 這個方法通常由資料庫提供者 (和其他延伸模組) 使用。 它通常不會用於應用程式程式碼。
FindOverrides(IReadOnlyProperty, StoreObjectIdentifier)	傳回特定類似資料表之存放區物件的屬性 Facet 覆寫。 這個方法通常由資料庫提供者 (和其他延伸模組) 使用。 它通常不會用於應用程式程式碼。
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)	傳回所有屬性 Facet 覆寫。 這個方法通常由資料庫提供者使用， (和其他延伸模組) 。 它通常不會用於應用程式程式碼中。
GetOverrides(IReadOnlyProperty)	傳回所有屬性 Facet 覆寫。 這個方法通常由資料庫提供者使用， (和其他延伸模組) 。 它通常不會用於應用程式程式碼中。
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)	傳回識別遞增。
GetIdentityIncrement(IReadOnlyProperty, StoreObjectIdentifier)	傳回識別遞增。
GetIdentitySeed(IReadOnlyProperty)	傳回身分識別種子。
GetIdentitySeed(IReadOnlyProperty, StoreObjectIdentifier)	傳回身分識別種子。
GetSequenceName(IReadOnlyProperty)	傳回要用於索引鍵值產生序列的名稱。
GetSequenceName(IReadOnlyProperty, StoreObjectIdentifier)	傳回要用於索引鍵值產生序列的名稱。
GetSequenceSchema(IReadOnlyProperty)	傳回要用於索引鍵值產生序列的架構。
GetSequenceSchema(IReadOnlyProperty, StoreObjectIdentifier)	傳回要用於索引鍵值產生序列的架構。
GetValueGenerationStrategy(IReadOnlyProperty)	傳 SqlServerValueGenerationStrategy 回 要用於 屬性的 。
GetValueGenerationStrategy(IReadOnlyProperty, StoreObjectIdentifier)	傳 SqlServerValueGenerationStrategy 回 要用於 屬性的 。
IsSparse(IReadOnlyProperty)	傳回值，指出屬性的資料行是否疏鬆。
IsSparse(IReadOnlyProperty, StoreObjectIdentifier)	傳回值，指出屬性的資料行是否疏鬆。