IReadOnlyProperty Interface
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Représente une propriété scalaire d’un type structurel.
public interface IReadOnlyProperty : Microsoft.EntityFrameworkCore.Metadata.IReadOnlyPropertyBase
type IReadOnlyProperty = interface
interface IReadOnlyPropertyBase
interface IReadOnlyAnnotatable
Public Interface IReadOnlyProperty
Implements IReadOnlyPropertyBase
- Dérivé
- Implémente
Remarques
Pour plus d’informations et d’exemples, consultez Modélisation des types d’entités et des relations .
Propriétés
| Nom | Description |
|---|---|
| ClrType |
Obtient le type de valeur que contient cet objet de type propriété. (Hérité de IReadOnlyPropertyBase) |
| DeclaringEntityType |
Obsolète.
Obtient le type d’entité auquel appartient cette propriété. |
| DeclaringType |
Obtient le type auquel appartient cet objet de type propriété. (Hérité de IReadOnlyPropertyBase) |
| FieldInfo |
Obtient le FieldInfo champ CLR sous-jacent pour cet objet de type propriété.
Cela peut être |
| IsAutoLoaded |
Obtient une valeur indiquant si cette propriété est automatiquement chargée lorsque l’entité est interrogée à partir de la base de données.
Lorsqu’elle est définie |
| IsCollection |
Obtient une valeur indiquant si la propriété est une collection. (Hérité de IReadOnlyPropertyBase) |
| IsConcurrencyToken |
Obtient une valeur indiquant si cette propriété est utilisée comme jeton d’accès concurrentiel. Lorsqu’une propriété est configurée en tant que jeton d’accès concurrentiel, la valeur de la base de données est vérifiée lorsqu’une instance de ce type d’entité est mise à jour ou supprimée pendant SaveChanges() pour s’assurer qu’elle n’a pas changé depuis la récupération de l’instance à partir de la base de données. Si elle a changé, une exception est levée et les modifications ne seront pas appliquées à la base de données. |
| IsNullable |
Obtient une valeur indiquant si cette propriété peut contenir |
| 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. |
| Item[String] |
Obtient la valeur de l’annotation portant le nom donné, en retournant |
| Name |
Obtient le nom de cet objet de type propriété. (Hérité de IReadOnlyPropertyBase) |
| PropertyInfo |
Obtient la PropertyInfo propriété CLR sous-jacente pour cet objet de type propriété.
Cela peut être |
| Sentinel |
Obtient la valeur sentinelle qui indique que cette propriété n’est pas définie. (Hérité de IReadOnlyPropertyBase) |
| ValueGenerated |
Obtient une valeur indiquant quand une valeur pour cette propriété sera générée par la base de données. Même lorsque la propriété est définie pour être générée par la base de données, EF peut toujours tenter d’enregistrer une valeur spécifique (au lieu d’en avoir une générée par la base de données) lorsque l’entité est ajoutée et qu’une valeur est affectée ou que la propriété est marquée comme modifiée pour une entité existante. Pour plus d’informations et d’exemples, consultez GetBeforeSaveBehavior() et GetAfterSaveBehavior() pour plus d’informations. |
Méthodes
| Nom | Description |
|---|---|
| AnnotationsToDebugString(Int32) |
Obtient la chaîne de débogage pour toutes les annotations déclarées sur l’objet. (Hérité de IReadOnlyAnnotatable) |
| FindAnnotation(String) |
Obtient l’annotation portant le nom donné, en retournant |
| 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. |
| FindTypeMapping() |
Retourne le mappage de type pour cette propriété. |
| GetAfterSaveBehavior() |
Obtient une valeur indiquant si cette propriété peut être modifiée une fois l’entité enregistrée dans la base de données. |
| GetAnnotation(String) |
Obtient l’annotation portant le nom donné, levée s’il 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. |
| 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 alternatives qui utilisent cette propriété (y compris les clés composites dans lesquelles cette propriété est incluse). |
| 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 de cette propriété ou |
| GetJsonValueReaderWriter() |
Obtient la JsonValueReaderWriter valeur de cette propriété, ou |
| GetKeyValueComparer() |
Obtient l’utilisation ValueComparer avec des clés pour cette propriété, ou |
| GetMaxLength() |
Obtient la longueur maximale des données autorisées dans cette propriété. Par exemple, si la propriété est une String valeur, il s’agit du nombre maximal de caractères. |
| GetPrecision() |
Obtient la précision des données autorisées dans cette propriété. Par exemple, si la propriété est une Decimal valeur, il s’agit du nombre maximal de chiffres. |
| GetPrincipals() |
Recherche la liste des propriétés principales, y compris la propriété donnée par laquelle la propriété donnée est limitée 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 limitée si la propriété donnée fait partie d’une clé étrangère. |
| GetPropertyAccessMode() |
Obtient l’objet PropertyAccessMode utilisé pour cet objet de type 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. |
| GetProviderValueComparer() |
Obtient la ValueComparer valeur à utiliser pour les valeurs du fournisseur pour cette propriété. |
| GetScale() |
Obtient l’échelle des données autorisées dans cette propriété. Par exemple, si la propriété est une Decimal valeur, il s’agit du nombre maximal de décimales. |
| GetTypeMapping() |
Retourne la CoreTypeMapping propriété donnée à partir d’un modèle finalisé. |
| GetValueComparer() |
Obtient la ValueComparer valeur de cette propriété, ou |
| GetValueConverter() |
Obtient l’ensemble personnalisé ValueConverter de cette propriété. |
| GetValueGeneratorFactory() |
Obtient la fabrique qui a été définie pour générer des valeurs pour cette propriété, le cas échéant. |
| IsForeignKey() |
Obtient une valeur indiquant si cette propriété est utilisée comme clé étrangère (ou une partie d’une clé étrangère composite). |
| IsIndex() |
Obtient une valeur indiquant si cette propriété est utilisée comme index (ou partie d’un index composite). |
| 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 une partie d’une clé primaire ou alternative composite). |
| IsPrimaryKey() |
Obtient une valeur indiquant si cette propriété est utilisée comme clé primaire (ou une partie d’une clé primaire composite). |
| IsShadowProperty() |
Obtient une valeur indiquant s’il s’agit d’une propriété d’ombre. Une propriété d’ombre est une propriété qui n’a pas de propriété correspondante dans la classe d’entité. La valeur actuelle de la propriété est stockée au ChangeTracker lieu d’être stockée dans les instances de la classe d’entité. (Hérité de IReadOnlyPropertyBase) |
| IsUnicode() |
Obtient une valeur indiquant si la propriété peut conserver des caractères Unicode. |
| IsUniqueIndex() |
Obtient une valeur indiquant si cette propriété est utilisée comme index unique (ou une partie d’un index composite unique). |
| ToDebugString(MetadataDebugStringOptions, Int32) |
Crée une représentation lisible par l’homme des métadonnées données. Avertissement : Ne vous appuyez pas sur le format de la chaîne retournée. Il est conçu pour le débogage uniquement et peut changer arbitrairement entre les versions. |
Méthodes d’extension
| Nom | Description |
|---|---|
| FindHiLoSequence(IReadOnlyProperty, StoreObjectIdentifier) |
Recherche dans ISequence le modèle à utiliser pour le modèle hi-lo. |
| FindHiLoSequence(IReadOnlyProperty) |
Recherche dans ISequence le modèle à utiliser pour le modèle hi-lo. |
| FindOverrides(IReadOnlyProperty, StoreObjectIdentifier) |
Retourne les remplacements de facettes 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 d’application. |
| FindRelationalTypeMapping(IReadOnlyProperty, StoreObjectIdentifier) |
Retourne la RelationalTypeMapping propriété donnée sur un modèle finalisé. |
| FindRelationalTypeMapping(IReadOnlyProperty) |
Retourne la RelationalTypeMapping propriété donnée sur un modèle finalisé. |
| FindSequence(IReadOnlyProperty, StoreObjectIdentifier) |
Recherche dans ISequence le modèle à utiliser pour le modèle de génération de valeur de clé. |
| FindSequence(IReadOnlyProperty) |
Recherche dans ISequence le modèle à utiliser pour le modèle de génération de valeur de clé. |
| FindSharedStoreObjectRootProperty(IReadOnlyProperty, StoreObjectIdentifier) |
Recherche le premier IProperty mappé à 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 d’application. |
| GetCollation(IReadOnlyProperty, StoreObjectIdentifier) |
Retourne le classement à utiliser pour la colonne. |
| GetCollation(IReadOnlyProperty) |
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, StoreObjectIdentifier) |
Retourne le nom de la colonne à laquelle la propriété est mappée pour une table particulière. |
| GetColumnName(IReadOnlyProperty) |
Retourne le nom de la colonne à laquelle la propriété serait mappée. |
| GetColumnOrder(IReadOnlyProperty, StoreObjectIdentifier) |
Retourne l’ordre de la colonne à laquelle cette 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. |
| GetColumnType(IReadOnlyProperty, StoreObjectIdentifier) |
Retourne le type de base de données de la colonne à laquelle la propriété est mappée, ou |
| GetColumnType(IReadOnlyProperty) |
Retourne le type de base de données de la colonne à laquelle la propriété est mappée, ou |
| GetComment(IReadOnlyProperty, StoreObjectIdentifier) |
Retourne le commentaire de la colonne à laquelle cette propriété est mappée. |
| GetComment(IReadOnlyProperty) |
Retourne le commentaire de 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. |
| GetComputedColumnSql(IReadOnlyProperty) |
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 |
| GetDefaultColumnName(IReadOnlyProperty, StoreObjectIdentifier) |
Retourne le nom de colonne par défaut auquel 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 |
| GetDefaultConstraintName(IReadOnlyProperty, StoreObjectIdentifier) |
Obtient le nom de contrainte par défaut. |
| GetDefaultConstraintName(IReadOnlyProperty) |
Obtient le nom de contrainte par défaut. |
| GetDefaultDefaultConstraintName(IReadOnlyProperty, StoreObjectIdentifier) |
Génère le nom de contrainte par défaut en fonction du nom de la table et de la colonne. |
| GetDefaultValue(IReadOnlyProperty, StoreObjectIdentifier) |
Retourne l’objet utilisé comme valeur par défaut pour la colonne à laquelle cette propriété est mappée. |
| GetDefaultValue(IReadOnlyProperty) |
Retourne l’objet utilisé comme valeur par défaut pour la colonne à laquelle cette propriété est mappée. |
| GetDefaultValueGenerationStrategy(IReadOnlyProperty) |
Retourne la valeur par défaut SqliteValueGenerationStrategy à utiliser pour la propriété. |
| GetDefaultValueSql(IReadOnlyProperty, StoreObjectIdentifier) |
Retourne l’expression SQL utilisée 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. |
| GetFullTextSearchLanguage(IReadOnlyProperty) |
Retourne la langue de recherche en texte intégral définie pour cette propriété. |
| GetHiLoSequenceName(IReadOnlyProperty, StoreObjectIdentifier) |
Retourne le nom à utiliser pour la séquence hi-lo. |
| GetHiLoSequenceName(IReadOnlyProperty) |
Retourne le nom à utiliser pour la séquence hi-lo. |
| GetHiLoSequenceSchema(IReadOnlyProperty, StoreObjectIdentifier) |
Retourne le schéma à utiliser pour la séquence hi-lo. |
| GetHiLoSequenceSchema(IReadOnlyProperty) |
Retourne le schéma à utiliser pour la séquence hi-lo. |
| GetIdentityIncrement(IReadOnlyProperty, StoreObjectIdentifier) |
Retourne l’incrément d’identité. |
| GetIdentityIncrement(IReadOnlyProperty) |
Retourne l’incrément d’identité. |
| GetIdentitySeed(IReadOnlyProperty, StoreObjectIdentifier) |
Retourne la valeur initiale de l’identité. |
| GetIdentitySeed(IReadOnlyProperty) |
Retourne la valeur initiale de l’identité. |
| GetIsFullTextSearchEnabled(IReadOnlyProperty) |
Retourne la valeur indiquant si la recherche en texte intégral est activée pour cette propriété. |
| 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 lorsqu’elle est lue. |
| 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 lorsqu’elle est lue. |
| GetJsonPropertyName(IReadOnlyProperty) |
Retourne le nom de propriété auquel la propriété est mappée lors du ciblage de Cosmos. |
| GetJsonPropertyName(IReadOnlyProperty) |
Obtient la valeur du nom de propriété JSON utilisée 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 d’application. |
| GetMaxLength(IReadOnlyProperty, StoreObjectIdentifier) |
Obtient la longueur maximale des données autorisées dans cette propriété. Par exemple, si la propriété est une String valeur, il s’agit du nombre maximal de caractères. |
| GetOverrides(IReadOnlyProperty) |
Retourne toutes les substitutions de facettes 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 d’application. |
| GetPrecision(IReadOnlyProperty, StoreObjectIdentifier) |
Obtient la précision des données autorisées dans cette propriété. Par exemple, si la propriété est une Decimal valeur, il s’agit du nombre maximal de chiffres. |
| GetRelationalTypeMapping(IReadOnlyProperty) |
Retourne la RelationalTypeMapping 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 une Decimal valeur, il s’agit du nombre maximal de décimales. |
| GetSequenceName(IReadOnlyProperty, StoreObjectIdentifier) |
Retourne le nom à utiliser pour la séquence de génération de valeur de clé. |
| GetSequenceName(IReadOnlyProperty) |
Retourne le nom à 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é. |
| GetSequenceSchema(IReadOnlyProperty) |
Retourne le schéma à utiliser pour la séquence de génération de valeur de clé. |
| GetSrid(IReadOnlyProperty, StoreObjectIdentifier) |
Retourne le SRID à utiliser lors de la création d’une colonne pour cette propriété. |
| GetSrid(IReadOnlyProperty) |
Retourne le SRID à utiliser lors de la création d’une colonne pour cette propriété. |
| GetValueGenerationStrategy(IReadOnlyProperty, StoreObjectIdentifier) |
Retourne la SqliteValueGenerationStrategy valeur à utiliser pour la propriété. |
| GetValueGenerationStrategy(IReadOnlyProperty, StoreObjectIdentifier) |
Retourne la SqlServerValueGenerationStrategy valeur à utiliser pour la propriété. |
| GetValueGenerationStrategy(IReadOnlyProperty) |
Retourne la SqliteValueGenerationStrategy valeur à utiliser pour la propriété. |
| GetValueGenerationStrategy(IReadOnlyProperty) |
Retourne la SqlServerValueGenerationStrategy valeur à utiliser pour la propriété. |
| GetVectorDimensions(IReadOnlyProperty) |
Retourne les dimensions du vecteur stocké dans cette propriété. |
| GetVectorDistanceFunction(IReadOnlyProperty) |
Retourne la fonction de distance du vecteur stocké dans cette propriété. |
| GetVectorType(IReadOnlyProperty) |
Retourne la définition du vecteur stocké dans cette propriété. |
| IsColumnNullable(IReadOnlyProperty, StoreObjectIdentifier) |
Vérifie si la colonne mappée à la propriété donnée est nullable lors de sa création dans la base de données. |
| IsColumnNullable(IReadOnlyProperty) |
Vérifie si la colonne mappée à l’élément donné IProperty sera nullable lors de sa création dans la base de données. |
| 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. |
| 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. |
| IsHidden(IReadOnlyProperty) |
Retourne une valeur indiquant si la colonne de la propriété est définie avec l'indicateur SQL Server |
| IsSparse(IReadOnlyProperty, StoreObjectIdentifier) |
Retourne une valeur indiquant si la colonne de la propriété est éparse. |
| IsSparse(IReadOnlyProperty) |
Retourne une valeur indiquant si la colonne de la propriété est éparse. |
| IsUnicode(IReadOnlyProperty, StoreObjectIdentifier) |
Obtient une valeur indiquant si la propriété peut conserver ou non des caractères Unicode. |
| TryGetDefaultValue(IReadOnlyProperty, Object) |
Retourne l’objet utilisé comme valeur par défaut pour la colonne à laquelle cette propriété est mappée. |
| TryGetDefaultValue(IReadOnlyProperty, StoreObjectIdentifier, Object) |
Retourne l’objet utilisé comme valeur par défaut pour la colonne à laquelle cette propriété est mappée. |