IProperty Interface

Définition

Espace de noms:

Microsoft.EntityFrameworkCore.Metadata

Assembly:

Microsoft.EntityFrameworkCore.dll

Paquet:

Microsoft.EntityFrameworkCore v8.0.0

Représente une propriété scalaire d’un type structurel.

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

Dérivé

Microsoft.EntityFrameworkCore.Metadata.RuntimeProperty

Implémente

IAnnotatable IPropertyBase IReadOnlyAnnotatable IReadOnlyProperty IReadOnlyPropertyBase

Remarques

Pour plus d’informations et d’exemples, consultez Modélisation des types d’entités et des relations .

Propriétés

DeclaringEntityType	Obsolète.. Obtient le type d’entité auquel cette propriété appartient.
DeclaringType	Obtient le type auquel cet objet semblable à une propriété appartient. (Hérité de IReadOnlyPropertyBase)
FieldInfo	Obtient le FieldInfo pour le champ CLR sous-jacent pour cet objet semblable à une propriété. Il peut null s’agir de propriétés d’ombre ou si le champ de stockage n’est pas connu. (Hérité de IReadOnlyPropertyBase)
IsPrimitiveCollection	Une propriété est une collection primitive si elle a un type d’élément qui correspond au type d’élément du type CLR. (Hérité de IReadOnlyProperty)
Item[String]	Obtient la valeur de l’annotation portant le nom donné, en retournant null si elle n’existe pas. (Hérité de IReadOnlyAnnotatable)
Name	Obtient le nom de cet objet semblable à une propriété. (Hérité de IReadOnlyPropertyBase)
PropertyInfo	Obtient le PropertyInfo pour la propriété CLR sous-jacente pour cet objet semblable à une propriété. Il peut s’agir null de propriétés d’ombre ou si elles sont mappées directement à un champ. (Hérité de IReadOnlyPropertyBase)
Sentinel	Obtient la valeur sentinelle qui indique que cette propriété n’est pas définie. (Hérité de IReadOnlyPropertyBase)

Méthodes

AddRuntimeAnnotation(String, Object)	Ajoute une annotation d’exécution à cet objet. Lève si une annotation portant le nom spécifié existe déjà. (Hérité de IAnnotatable)
AnnotationsToDebugString(Int32)	Obtient la chaîne de débogage pour toutes les annotations déclarées sur l’objet . (Hérité de IReadOnlyAnnotatable)
CreateKeyEqualityComparer<TProperty>()	Crée un IEqualityComparer<T> pour les valeurs du type de propriété donné.
FindAnnotation(String)	Obtient l’annotation avec le nom donné, en retournant null si elle n’existe pas. (Hérité de IReadOnlyAnnotatable)
FindContainingPrimaryKey()	Obtient la clé primaire qui utilise cette propriété (y compris une clé primaire composite dans laquelle cette propriété est incluse).
FindFirstPrincipal()	Recherche la première propriété principale par laquelle la propriété donnée est contrainte si la propriété donnée fait partie d’une clé étrangère.
FindRuntimeAnnotation(String)	Obtient l’annotation d’exécution avec le nom donné, en retournant null si elle n’existe pas. (Hérité de IAnnotatable)
FindRuntimeAnnotationValue(String)	Obtient la valeur de l’annotation runtime avec le nom donné, en retournant null si elle n’existe pas. (Hérité de IAnnotatable)
FindTypeMapping()	Retourne le mappage de type pour cette propriété. (Hérité de IReadOnlyProperty)
GetAfterSaveBehavior()	Obtient une valeur indiquant si cette propriété peut être modifiée après l’enregistrement de l’entité dans la base de données. (Hérité de IReadOnlyProperty)
GetAnnotation(String)	Obtient l’annotation portant le nom donné, en lisant si elle n’existe pas. (Hérité de IReadOnlyAnnotatable)
GetAnnotations()	Obtient toutes les annotations sur l’objet actuel. (Hérité de IReadOnlyAnnotatable)
GetBeforeSaveBehavior()	Obtient une valeur indiquant si cette propriété peut être modifiée avant l’enregistrement de l’entité dans la base de données. (Hérité de IReadOnlyProperty)
GetContainingForeignKeys()	Obtient toutes les clés étrangères qui utilisent cette propriété (y compris les clés étrangères composites dans lesquelles cette propriété est incluse).
GetContainingIndexes()	Obtient tous les index qui utilisent cette propriété (y compris les index composites dans lesquels cette propriété est incluse).
GetContainingKeys()	Obtient toutes les clés primaires ou secondaires qui utilisent cette propriété (y compris les clés composites dans lesquelles cette propriété est incluse).
GetCurrentValueComparer()	Obtient un IComparer<T> pour comparer des valeurs dans les entrées suivies IUpdateEntry . (Hérité de IPropertyBase)
GetElementType()	Obtient la configuration des éléments de la collection primitive représentée par cette propriété.
GetFieldName()	Obtient le nom du champ de stockage pour cette propriété, ou null si le champ de stockage n’est pas connu. (Hérité de IReadOnlyPropertyBase)
GetGetter()	Obtient un IClrPropertyGetter pour la lecture de la valeur de cette propriété. (Hérité de IPropertyBase)
GetIndex()	Obtient l’index de propriété pour cette propriété. (Hérité de IPropertyBase)
GetJsonValueReaderWriter()	Obtient le JsonValueReaderWriter pour cette propriété, ou null si aucun n’est défini. (Hérité de IReadOnlyProperty)
GetKeyValueComparer()	Obtient le ValueComparer à utiliser avec les clés de cette propriété.
GetMaxLength()	Obtient la longueur maximale des données autorisées dans cette propriété. Par exemple, si la propriété est un String , il s’agit du nombre maximal de caractères. (Hérité de IReadOnlyProperty)
GetMemberInfo(Boolean, Boolean)	Obtient ou PropertyInfoFieldInfo qui doit être utilisé pour obtenir ou définir une valeur pour la propriété donnée. (Hérité de IPropertyBase)
GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg)	Obtient la valeur de l’annotation runtime avec le nom donné, en l’ajoutant si elle n’existe pas. (Hérité de IAnnotatable)
GetPrecision()	Obtient la précision des données autorisées dans cette propriété. Par exemple, si la propriété est un Decimal , il s’agit du nombre maximal de chiffres. (Hérité de IReadOnlyProperty)
GetPrincipals()	Recherche la liste des propriétés principales, y compris la propriété donnée par laquelle la propriété donnée est contrainte si la propriété donnée fait partie d’une clé étrangère.
GetPrincipals<T>()	Recherche la liste des propriétés principales, y compris la propriété donnée par laquelle la propriété donnée est contrainte si la propriété donnée fait partie d’une clé étrangère. (Hérité de IReadOnlyProperty)
GetPropertyAccessMode()	Obtient le PropertyAccessMode utilisé pour cet objet semblable à une propriété. (Hérité de IReadOnlyPropertyBase)
GetProviderClrType()	Obtient le type vers lequel la valeur de propriété sera convertie avant d’être envoyée au fournisseur de base de données. (Hérité de IReadOnlyProperty)
GetProviderValueComparer()	Obtient le ValueComparer à utiliser pour les valeurs du fournisseur pour cette propriété.
GetRuntimeAnnotations()	Obtient toutes les annotations d’exécution sur l’objet actuel. (Hérité de IAnnotatable)
GetScale()	Obtient l’échelle des données autorisées dans cette propriété. Par exemple, si la propriété est un Decimal , il s’agit du nombre maximal de décimales. (Hérité de IReadOnlyProperty)
GetTypeMapping()	Retourne pour CoreTypeMapping la propriété donnée à partir d’un modèle finalisé. (Hérité de IReadOnlyProperty)
GetValueComparer()	Obtient le ValueComparer pour cette propriété.
GetValueConverter()	Obtient le jeu personnalisé ValueConverter pour cette propriété. (Hérité de IReadOnlyProperty)
GetValueGeneratorFactory()	Obtient la fabrique qui a été définie pour générer des valeurs pour cette propriété, le cas échéant. (Hérité de IReadOnlyProperty)
IsForeignKey()	Obtient une valeur indiquant si cette propriété est utilisée en tant que clé étrangère (ou partie d’une clé étrangère composite). (Hérité de IReadOnlyProperty)
IsIndex()	Obtient une valeur indiquant si cette propriété est utilisée en tant qu’index (ou partie d’un index composite). (Hérité de IReadOnlyProperty)
IsIndexerProperty()	Obtient une valeur indiquant s’il s’agit d’une propriété d’indexeur. Une propriété d’indexeur est une propriété accessible via un indexeur sur la classe d’entité. (Hérité de IReadOnlyPropertyBase)
IsKey()	Obtient une valeur indiquant si cette propriété est utilisée comme clé primaire ou autre clé (ou partie d’une clé primaire ou secondaire composite). (Hérité de IReadOnlyProperty)
IsPrimaryKey()	Obtient une valeur indiquant si cette propriété est utilisée comme clé primaire (ou comme partie d’une clé primaire composite). (Hérité de IReadOnlyProperty)
IsUnicode()	Obtient une valeur indiquant si la propriété peut conserver les caractères Unicode. (Hérité de IReadOnlyProperty)
IsUniqueIndex()	Obtient une valeur indiquant si cette propriété est utilisée en tant qu’index unique (ou partie d’un index composite unique). (Hérité de IReadOnlyProperty)
RemoveRuntimeAnnotation(String)	Supprime l’annotation d’exécution donnée de cet objet. (Hérité de IAnnotatable)
SetRuntimeAnnotation(String, Object)	Définit l’annotation d’exécution stockée sous la clé donnée. Remplace l’annotation existante si une annotation portant le nom spécifié existe déjà. (Hérité de IAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)	Crée une représentation lisible des métadonnées données. Avertissement : ne vous fiez pas au format de la chaîne retournée. Il est conçu pour le débogage uniquement et peut changer arbitrairement entre les versions. (Hérité de IReadOnlyProperty)

Méthodes d’extension

GetJsonPropertyName(IReadOnlyProperty)	Retourne le nom de propriété auquel la propriété est mappée lors du ciblage de Cosmos.
FindColumn(IProperty, StoreObjectIdentifier)	Retourne la colonne correspondant à cette propriété si elle est mappée à l’objet de magasin de type table donné.
FindOverrides(IProperty, StoreObjectIdentifier)	Retourne les remplacements de facette de propriété pour un objet de magasin de type table particulier. Cette méthode est généralement utilisée par les fournisseurs de base de données (et d’autres extensions). Il n’est généralement pas utilisé dans le code de l’application.
FindOverrides(IReadOnlyProperty, StoreObjectIdentifier)	Retourne les remplacements de facette de propriété pour un objet de magasin de type table particulier. Cette méthode est généralement utilisée par les fournisseurs de base de données (et d’autres extensions). Il n’est généralement pas utilisé dans le code de l’application.
FindRelationalTypeMapping(IReadOnlyProperty)	Retourne le RelationalTypeMapping pour la propriété donnée sur un modèle finalisé.
FindRelationalTypeMapping(IReadOnlyProperty, StoreObjectIdentifier)	Retourne le RelationalTypeMapping pour la propriété donnée sur un modèle finalisé.
FindSharedStoreObjectRootProperty(IProperty, StoreObjectIdentifier)	Recherche la première IProperty qui est mappée à la même colonne dans un objet de type table partagé. Cette méthode est généralement utilisée par les fournisseurs de base de données (et d’autres extensions). Il n’est généralement pas utilisé dans le code de l’application.
FindSharedStoreObjectRootProperty(IReadOnlyProperty, StoreObjectIdentifier)	Recherche la première IProperty qui est mappée à la même colonne dans un objet de type table partagé. Cette méthode est généralement utilisée par les fournisseurs de base de données (et d’autres extensions). Il n’est généralement pas utilisé dans le code de l’application.
GetCollation(IReadOnlyProperty)	Retourne le classement à utiliser pour la colonne.
GetCollation(IReadOnlyProperty, StoreObjectIdentifier)	Retourne le classement à utiliser pour la colonne.
GetColumnBaseName(IReadOnlyProperty)	Obsolète.. Retourne le nom de base de la colonne à laquelle la propriété serait mappée.
GetColumnName(IReadOnlyProperty)	Retourne le nom de la colonne à laquelle la propriété serait mappée.
GetColumnName(IReadOnlyProperty, StoreObjectIdentifier)	Retourne le nom de la colonne à laquelle la propriété est mappée pour une table particulière.
GetColumnOrder(IReadOnlyProperty)	Retourne l’ordre de la colonne à laquelle cette propriété est mappée.
GetColumnOrder(IReadOnlyProperty, StoreObjectIdentifier)	Retourne l’ordre de la colonne à laquelle cette propriété est mappée pour une table particulière.
GetColumnType(IProperty)	Retourne le type de base de données de la colonne à laquelle la propriété est mappée.
GetColumnType(IProperty, StoreObjectIdentifier)	Retourne le type de base de données de la colonne à laquelle la propriété est mappée.
GetColumnType(IReadOnlyProperty)	Retourne le type de base de données de la colonne à laquelle la propriété est mappée, ou null si le type de base de données est introuvable.
GetColumnType(IReadOnlyProperty, StoreObjectIdentifier)	Retourne le type de base de données de la colonne à laquelle la propriété est mappée, ou null si le type de base de données est introuvable.
GetComment(IReadOnlyProperty)	Retourne le commentaire pour la colonne à laquelle cette propriété est mappée.
GetComment(IReadOnlyProperty, StoreObjectIdentifier)	Retourne le commentaire pour la colonne à laquelle cette propriété est mappée.
GetComputedColumnSql(IReadOnlyProperty)	Retourne l’expression SQL utilisée comme valeur calculée pour la colonne à laquelle cette propriété est mappée.
GetComputedColumnSql(IReadOnlyProperty, StoreObjectIdentifier)	Retourne l’expression SQL utilisée comme valeur calculée pour la colonne à laquelle cette propriété est mappée.
GetDefaultColumnBaseName(IReadOnlyProperty)	Obsolète.. Retourne le nom de base par défaut de la colonne à laquelle la propriété serait mappée
GetDefaultColumnMappings(IProperty)	Retourne les colonnes par défaut auxquelles la propriété serait mappée.
GetDefaultColumnName(IReadOnlyProperty)	Retourne le nom de base par défaut de la colonne à laquelle la propriété serait mappée
GetDefaultColumnName(IReadOnlyProperty, StoreObjectIdentifier)	Retourne le nom de colonne par défaut auquel la propriété serait mappée.
GetDefaultValue(IReadOnlyProperty)	Retourne l’objet utilisé comme valeur par défaut pour la colonne à laquelle cette propriété est mappée.
GetDefaultValue(IReadOnlyProperty, StoreObjectIdentifier)	Retourne l’objet utilisé comme valeur par défaut pour la colonne à laquelle cette propriété est mappée.
GetDefaultValueSql(IReadOnlyProperty)	Retourne l’expression SQL utilisée comme valeur par défaut pour la colonne à laquelle cette propriété est mappée.
GetDefaultValueSql(IReadOnlyProperty, StoreObjectIdentifier)	Retourne l’expression SQL utilisée comme valeur par défaut pour la colonne à laquelle cette propriété est mappée.
GetDeleteStoredProcedureParameterMappings(IProperty)	Retourne les paramètres de procédure stockée de suppression auxquels la propriété est mappée.
GetFunctionColumnMappings(IProperty)	Retourne les colonnes de fonction auxquelles la propriété est mappée.
GetInsertStoredProcedureParameterMappings(IProperty)	Retourne les paramètres de procédure stockée d’insertion auxquels la propriété est mappée.
GetInsertStoredProcedureResultColumnMappings(IProperty)	Retourne les colonnes de résultat de la procédure stockée d’insertion auxquelles la propriété est mappée.
GetIsStored(IReadOnlyProperty)	Obtient si la valeur de la colonne calculée à laquelle cette propriété est mappée est stockée dans la base de données ou calculée lors de sa lecture.
GetIsStored(IReadOnlyProperty, StoreObjectIdentifier)	Obtient si la valeur de la colonne calculée à laquelle cette propriété est mappée est stockée dans la base de données ou calculée lors de sa lecture.
GetJsonPropertyName(IReadOnlyProperty)	Obtient la valeur du nom de propriété JSON utilisé pour la propriété donnée d’une entité mappée à une colonne JSON.
GetMappedStoreObjects(IReadOnlyProperty, StoreObjectType)	Retourne les objets de magasin de type table auxquels cette propriété est mappée. Cette méthode est généralement utilisée par les fournisseurs de base de données (et d’autres extensions). Il n’est généralement pas utilisé dans le code de l’application.
GetMaxLength(IReadOnlyProperty, StoreObjectIdentifier)	Obtient la longueur maximale des données autorisées dans cette propriété. Par exemple, si la propriété est un String , il s’agit du nombre maximal de caractères.
GetOverrides(IProperty)	Retourne tous les remplacements de la facette de propriété. Cette méthode est généralement utilisée par les fournisseurs de base de données (et d’autres extensions). Il n’est généralement pas utilisé dans le code de l’application.
GetOverrides(IReadOnlyProperty)	Retourne tous les remplacements de la facette de propriété. Cette méthode est généralement utilisée par les fournisseurs de base de données (et d’autres extensions). Il n’est généralement pas utilisé dans le code de l’application.
GetPrecision(IReadOnlyProperty, StoreObjectIdentifier)	Obtient la précision des données autorisées dans cette propriété. Par exemple, si la propriété est un Decimal , il s’agit du nombre maximal de chiffres.
GetReaderFieldValue(IProperty, RelationalDataReader, Int32, Boolean)	Lit une valeur pour cette propriété à partir du donné relationalReader.
GetRelationalTypeMapping(IReadOnlyProperty)	Retourne le RelationalTypeMapping pour la propriété donnée sur un modèle finalisé.
GetScale(IReadOnlyProperty, StoreObjectIdentifier)	Obtient l’échelle des données autorisées dans cette propriété. Par exemple, si la propriété est un Decimal , il s’agit du nombre maximal de décimales.
GetSqlQueryColumnMappings(IProperty)	Retourne les colonnes de requête SQL auxquelles la propriété est mappée.
GetTableColumnMappings(IProperty)	Retourne les colonnes de table auxquelles la propriété est mappée.
GetUpdateStoredProcedureParameterMappings(IProperty)	Retourne les paramètres de procédure stockée de mise à jour auxquels la propriété est mappée.
GetUpdateStoredProcedureResultColumnMappings(IProperty)	Retourne les colonnes de résultat de la procédure stockée de mise à jour auxquelles la propriété est mappée.
GetViewColumnMappings(IProperty)	Retourne les colonnes d’affichage auxquelles la propriété est mappée.
IsColumnNullable(IReadOnlyProperty)	Vérifie si la colonne mappée au donné IProperty peut avoir la valeur Null lors de sa création dans la base de données.
IsColumnNullable(IReadOnlyProperty, StoreObjectIdentifier)	Vérifie si la colonne mappée à la propriété donnée peut avoir la valeur Null lors de sa création dans la base de données.
IsFixedLength(IReadOnlyProperty)	Retourne un indicateur indiquant si la propriété est capable de stocker uniquement des données de longueur fixe, telles que des chaînes.
IsFixedLength(IReadOnlyProperty, StoreObjectIdentifier)	Retourne un indicateur indiquant si la propriété est capable de stocker uniquement des données de longueur fixe, telles que des chaînes.
IsUnicode(IReadOnlyProperty, StoreObjectIdentifier)	Obtient une valeur indiquant si la propriété peut conserver les caractères Unicode.
TryGetDefaultValue(IReadOnlyProperty, StoreObjectIdentifier, Object)	Retourne l’objet utilisé comme valeur par défaut pour la colonne à laquelle cette propriété est mappée.
TryGetDefaultValue(IReadOnlyProperty, Object)	Retourne l’objet utilisé comme valeur par défaut pour la colonne à laquelle cette propriété est mappée.
GetDataAnnotations(IProperty, IAnnotationCodeGenerator)	Obtient les annotations de données pour configurer une propriété.
GetFluentApiCalls(IProperty, IAnnotationCodeGenerator)	Obtient les appels d’API Fluent pour configurer une propriété.
GetSrid(IReadOnlyProperty)	Retourne le SRID à utiliser lors de la création d’une colonne pour cette propriété.
GetSrid(IReadOnlyProperty, StoreObjectIdentifier)	Retourne le SRID à utiliser lors de la création d’une colonne pour cette propriété.
FindHiLoSequence(IProperty)	Recherche dans le ISequence modèle à utiliser pour le modèle hi-lo.
FindHiLoSequence(IProperty, StoreObjectIdentifier)	Recherche dans le ISequence modèle à utiliser pour le modèle hi-lo.
FindHiLoSequence(IReadOnlyProperty)	Recherche dans le ISequence modèle à utiliser pour le modèle hi-lo.
FindHiLoSequence(IReadOnlyProperty, StoreObjectIdentifier)	Recherche dans le ISequence modèle à utiliser pour le modèle hi-lo.
FindSequence(IProperty)	Recherche dans le ISequence modèle à utiliser pour le modèle de génération de valeur de clé.
FindSequence(IProperty, StoreObjectIdentifier)	Recherche dans le ISequence modèle à utiliser pour le modèle de génération de valeur de clé.
FindSequence(IReadOnlyProperty)	Recherche dans le ISequence modèle à utiliser pour le modèle de génération de valeur de clé.
FindSequence(IReadOnlyProperty, StoreObjectIdentifier)	Recherche dans le ISequence modèle à utiliser pour le modèle de génération de valeur de clé.
GetHiLoSequenceName(IReadOnlyProperty)	Retourne le nom à utiliser pour la séquence hi-lo.
GetHiLoSequenceName(IReadOnlyProperty, StoreObjectIdentifier)	Retourne le nom à utiliser pour la séquence hi-lo.
GetHiLoSequenceSchema(IReadOnlyProperty)	Retourne le schéma à utiliser pour la séquence hi-lo.
GetHiLoSequenceSchema(IReadOnlyProperty, StoreObjectIdentifier)	Retourne le schéma à utiliser pour la séquence hi-lo.
GetIdentityIncrement(IReadOnlyProperty)	Retourne l’incrément d’identité.
GetIdentityIncrement(IReadOnlyProperty, StoreObjectIdentifier)	Retourne l’incrément d’identité.
GetIdentitySeed(IReadOnlyProperty)	Retourne la valeur initiale de l’identité.
GetIdentitySeed(IReadOnlyProperty, StoreObjectIdentifier)	Retourne la valeur initiale de l’identité.
GetSequenceName(IReadOnlyProperty)	Retourne le nom à utiliser pour la séquence de génération de valeur de clé.
GetSequenceName(IReadOnlyProperty, StoreObjectIdentifier)	Retourne le nom à utiliser pour la séquence de génération de valeur de clé.
GetSequenceSchema(IReadOnlyProperty)	Retourne le schéma à utiliser pour la séquence de génération de valeur de clé.
GetSequenceSchema(IReadOnlyProperty, StoreObjectIdentifier)	Retourne le schéma à utiliser pour la séquence de génération de valeur de clé.
GetValueGenerationStrategy(IReadOnlyProperty)	Retourne le SqlServerValueGenerationStrategy à utiliser pour la propriété .
GetValueGenerationStrategy(IReadOnlyProperty, StoreObjectIdentifier)	Retourne le SqlServerValueGenerationStrategy à utiliser pour la propriété .
IsSparse(IReadOnlyProperty)	Retourne une valeur indiquant si la colonne de la propriété est éparse.
IsSparse(IReadOnlyProperty, StoreObjectIdentifier)	Retourne une valeur indiquant si la colonne de la propriété est éparse.