Langue

IConventionComplexProperty Interface

Définition

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

public interface IConventionComplexProperty : Microsoft.EntityFrameworkCore.Metadata.IConventionPropertyBase, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyComplexProperty
type IConventionComplexProperty = interface
    interface IReadOnlyComplexProperty
    interface IReadOnlyPropertyBase
    interface IReadOnlyAnnotatable
    interface IConventionPropertyBase
    interface IConventionAnnotatable
Public Interface IConventionComplexProperty
Implements IConventionPropertyBase, IReadOnlyComplexProperty
Implémente

Remarques

Cette interface est utilisée lors de la création du modèle et permet de modifier les métadonnées. Une fois le modèle généré, IComplexProperty représente une vue en lecture seule des mêmes métadonnées.

Pour plus d’informations et d’exemples, consultez les conventions de génération de modèles.

Propriétés

Nom Description
Builder

Obtient le générateur qui peut être utilisé pour configurer cette propriété.

ClrType

Obtient le type de valeur que contient cet objet de type propriété.

(Hérité de IReadOnlyPropertyBase)
ComplexType

Obtient le type complexe associé.

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 null destiné aux propriétés d’ombre ou si le champ de stockage n’est pas connu.

(Hérité de IReadOnlyPropertyBase)
IsCollection

Obtient une valeur indiquant si la propriété est une collection.

(Hérité de IReadOnlyPropertyBase)
IsInModel

Indique si cet objet se trouve dans un modèle, c’est-à-dire qu’il n’a pas été supprimé d’un modèle.

(Hérité de IConventionAnnotatable)
IsNullable

Obtient une valeur indiquant si cette propriété peut contenir null.

(Hérité de IReadOnlyComplexProperty)
Item[String]

Obtient la valeur de l’annotation portant le nom donné, en retournant null s’il n’existe pas.

(Hérité de IReadOnlyAnnotatable)
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 null destiné aux propriétés d’ombre ou s’ils sont mappés 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

Nom Description
AddAnnotation(String, Object, Boolean)

Ajoute une annotation à cet objet. Lève si une annotation portant le nom spécifié existe déjà.

(Hérité de IConventionAnnotatable)
AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean)

Ajoute des annotations à un objet.

(Hérité de IConventionAnnotatable)
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 null s’il n’existe pas.

(Hérité de IConventionAnnotatable)
GetAnnotation(String)

Obtient l’annotation portant le nom donné, levée s’il n’existe pas.

(Hérité de IConventionAnnotatable)
GetAnnotations()

Obtient toutes les annotations sur l’objet actuel.

(Hérité de IConventionAnnotatable)
GetConfigurationSource()

Retourne la source de configuration de cette propriété.

(Hérité de IConventionPropertyBase)
GetFieldInfoConfigurationSource()

Retourne la source de configuration pour FieldInfo.

(Hérité de IConventionPropertyBase)
GetFieldName()

Obtient le nom du champ de stockage de cette propriété ou null si le champ de stockage n’est pas connu.

(Hérité de IReadOnlyPropertyBase)
GetIsNullableConfigurationSource()

Retourne la source de configuration pour IsNullable.

GetPropertyAccessMode()

Obtient l’objet PropertyAccessMode utilisé pour cet objet de type propriété.

(Hérité de IReadOnlyPropertyBase)
GetPropertyAccessModeConfigurationSource()

Retourne la source de configuration pour GetPropertyAccessMode().

(Hérité de IConventionPropertyBase)
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)
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)
RemoveAnnotation(String)

Supprime l’annotation portant le nom donné de cet objet.

(Hérité de IConventionAnnotatable)
SetAnnotation(String, Object, Boolean)

Définit l’annotation stockée sous le nom donné. Remplace l’annotation existante si une annotation portant le nom spécifié existe déjà.

(Hérité de IConventionAnnotatable)
SetField(FieldInfo, Boolean)
Obsolète.

Définit le FieldInfo champ CLR sous-jacent que cette propriété doit utiliser.

Par défaut, le champ de stockage, s’il est trouvé ou a été spécifié, est utilisé lorsque de nouveaux objets sont construits, généralement lorsque les entités sont interrogées à partir de la base de données. Les propriétés sont utilisées pour tous les autres accès. Cela peut être modifié en appelant SetPropertyAccessMode(Nullable<PropertyAccessMode>, Boolean).

(Hérité de IConventionPropertyBase)
SetField(String, Boolean)

Définit le champ CLR sous-jacent que cette propriété doit utiliser. Cela peut être null destiné aux propriétés d’ombre ou si le champ de stockage de la propriété n’est pas connu.

(Hérité de IConventionPropertyBase)
SetFieldInfo(FieldInfo, Boolean)

Définit le FieldInfo champ CLR sous-jacent que cette propriété doit utiliser.

(Hérité de IConventionPropertyBase)
SetIsNullable(Nullable<Boolean>, Boolean)

Définit une valeur indiquant si cette propriété peut contenir null.

SetOrRemoveAnnotation(String, Object, Boolean)

Définit l’annotation stockée sous le nom donné. Remplace l’annotation existante si une annotation portant le nom spécifié existe déjà. Supprime l’annotation existante si null elle est fournie.

(Hérité de IConventionAnnotatable)
SetPropertyAccessMode(Nullable<PropertyAccessMode>, Boolean)

Définit la PropertyAccessMode valeur à utiliser pour cette propriété.

(Hérité de IConventionPropertyBase)
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.

(Hérité de IReadOnlyComplexProperty)

Méthodes d’extension

Nom Description
GetJsonPropertyName(IReadOnlyComplexProperty)

Retourne le nom de propriété auquel la propriété est mappée lors du ciblage de Cosmos.

GetJsonPropertyName(IReadOnlyComplexProperty)

Obtient la valeur du nom de propriété JSON utilisée pour la propriété complexe donnée d’une entité mappée à une colonne JSON.

GetJsonPropertyNameConfigurationSource(IConventionComplexProperty)

Obtient le ConfigurationSource nom de la propriété JSON pour une propriété complexe donnée.

GetMappedStoreObjects(IReadOnlyComplexProperty, StoreObjectType)

Retourne les objets de magasin de type table auxquels cette propriété complexe est mappée s’il est mappé à une colonne JSON.

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.

SetJsonPropertyName(IConventionComplexProperty, String, Boolean)

Définit la valeur du nom de propriété JSON utilisée pour la propriété complexe donnée d’une entité mappée à une colonne JSON.

S’applique à