Sprache

IConventionComplexProperty Schnittstelle

Definition

Stellt eine komplexe Eigenschaft eines Strukturtyps dar.

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
Implementiert

Hinweise

Diese Schnittstelle wird während der Modellerstellung verwendet und ermöglicht die Änderung der Metadaten. Nachdem das Modell erstellt wurde, IComplexProperty stellt sie eine schreibgeschützte Ansicht der gleichen Metadaten dar.

Weitere Informationen und Beispiele finden Sie unter Modellbaukonventionen .

Eigenschaften

Name Beschreibung
Builder

Ruft den Generator ab, der zum Konfigurieren dieser Eigenschaft verwendet werden kann.

ClrType

Ruft den Typ des Werts ab, den dieses eigenschaftsähnliche Objekt enthält.

(Geerbt von IReadOnlyPropertyBase)
ComplexType

Ruft den zugeordneten komplexen Typ ab.

DeclaringType

Ruft den Typ ab, zu dem dieses eigenschaftsähnliche Objekt gehört.

(Geerbt von IReadOnlyPropertyBase)
FieldInfo

Ruft das FieldInfo für das zugrunde liegende CLR-Feld für dieses eigenschaftsähnliche Objekt ab. Dies kann für Schatteneigenschaften gelten null oder wenn das Sicherungsfeld nicht bekannt ist.

(Geerbt von IReadOnlyPropertyBase)
IsCollection

Ruft einen Wert ab, der angibt, ob es sich bei der Eigenschaft um eine Auflistung handelt.

(Geerbt von IReadOnlyPropertyBase)
IsInModel

Gibt an, ob sich dieses Objekt in einem Modell befindet, d. h. nicht aus einem Objekt entfernt wurde.

(Geerbt von IConventionAnnotatable)
IsNullable

Ruft einen Wert ab, der angibt, ob diese Eigenschaft enthalten nullkann.

(Geerbt von IReadOnlyComplexProperty)
Item[String]

Ruft den Wert der Anmerkung mit dem angegebenen Namen ab, die zurückgegeben wird null , wenn sie nicht vorhanden ist.

(Geerbt von IReadOnlyAnnotatable)
Name

Ruft den Namen dieses eigenschaftsähnlichen Objekts ab.

(Geerbt von IReadOnlyPropertyBase)
PropertyInfo

Ruft die PropertyInfo für die zugrunde liegende CLR-Eigenschaft für dieses eigenschaftsähnliche Objekt ab. Dies kann für Schatteneigenschaften gelten null oder direkt einem Feld zugeordnet werden.

(Geerbt von IReadOnlyPropertyBase)
Sentinel

Ruft den Sentinelwert ab, der angibt, dass diese Eigenschaft nicht festgelegt ist.

(Geerbt von IReadOnlyPropertyBase)

Methoden

Name Beschreibung
AddAnnotation(String, Object, Boolean)

Fügt diesem Objekt eine Anmerkung hinzu. Löst aus, wenn bereits eine Anmerkung mit dem angegebenen Namen vorhanden ist.

(Geerbt von IConventionAnnotatable)
AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean)

Fügt einem Objekt Anmerkungen hinzu.

(Geerbt von IConventionAnnotatable)
AnnotationsToDebugString(Int32)

Ruft die Debugzeichenfolge für alle Anmerkungen ab, die für das Objekt deklariert sind.

(Geerbt von IReadOnlyAnnotatable)
FindAnnotation(String)

Ruft die Anmerkung mit dem angegebenen Namen ab, die zurückgegeben wird null , wenn sie nicht vorhanden ist.

(Geerbt von IConventionAnnotatable)
GetAnnotation(String)

Ruft die Anmerkung mit dem angegebenen Namen ab, die ausgelöst wird, wenn sie nicht vorhanden ist.

(Geerbt von IConventionAnnotatable)
GetAnnotations()

Ruft alle Anmerkungen für das aktuelle Objekt ab.

(Geerbt von IConventionAnnotatable)
GetConfigurationSource()

Gibt die Konfigurationsquelle für diese Eigenschaft zurück.

(Geerbt von IConventionPropertyBase)
GetFieldInfoConfigurationSource()

Gibt die Konfigurationsquelle für FieldInfo.

(Geerbt von IConventionPropertyBase)
GetFieldName()

Ruft den Namen des Sicherungsfelds für diese Eigenschaft ab, oder null wenn das Sicherungsfeld nicht bekannt ist.

(Geerbt von IReadOnlyPropertyBase)
GetIsNullableConfigurationSource()

Gibt die Konfigurationsquelle für IsNullable.

GetPropertyAccessMode()

Ruft das Objekt ab, das PropertyAccessMode für dieses eigenschaftsähnliche Objekt verwendet wird.

(Geerbt von IReadOnlyPropertyBase)
GetPropertyAccessModeConfigurationSource()

Gibt die Konfigurationsquelle für GetPropertyAccessMode().

(Geerbt von IConventionPropertyBase)
IsIndexerProperty()

Ruft einen Wert ab, der angibt, ob es sich um eine Indexereigenschaft handelt. Eine Indexereigenschaft ist eine Eigenschaft, auf die über einen Indexer für die Entitätsklasse zugegriffen wird.

(Geerbt von IReadOnlyPropertyBase)
IsShadowProperty()

Ruft einen Wert ab, der angibt, ob es sich um eine Schatteneigenschaft handelt. Eine Schatteneigenschaft ist eine Eigenschaft, die nicht über eine entsprechende Eigenschaft in der Entitätsklasse verfügt. Der aktuelle Wert für die Eigenschaft wird in den ChangeTracker Instanzen der Entitätsklasse gespeichert und nicht in Instanzen der Entitätsklasse gespeichert.

(Geerbt von IReadOnlyPropertyBase)
RemoveAnnotation(String)

Entfernt die Anmerkung mit dem angegebenen Namen aus diesem Objekt.

(Geerbt von IConventionAnnotatable)
SetAnnotation(String, Object, Boolean)

Legt die unter dem angegebenen Namen gespeicherte Anmerkung fest. Überschreibt die vorhandene Anmerkung, wenn bereits eine Anmerkung mit dem angegebenen Namen vorhanden ist.

(Geerbt von IConventionAnnotatable)
SetField(FieldInfo, Boolean)
Veraltet.

Legt das FieldInfo für das zugrunde liegende CLR-Feld fest, das diese Eigenschaft verwenden soll.

Standardmäßig wird das Sicherungsfeld verwendet, wenn eins gefunden oder angegeben wurde, wenn neue Objekte erstellt werden, in der Regel, wenn Entitäten aus der Datenbank abgefragt werden. Eigenschaften werden für alle anderen Zugriffe verwendet. Dies kann durch Aufrufen SetPropertyAccessMode(Nullable<PropertyAccessMode>, Boolean)geändert werden.

(Geerbt von IConventionPropertyBase)
SetField(String, Boolean)

Legt das zugrunde liegende CLR-Feld fest, das diese Eigenschaft verwenden soll. Dies kann für Schatteneigenschaften gelten null oder wenn das Sicherungsfeld für die Eigenschaft nicht bekannt ist.

(Geerbt von IConventionPropertyBase)
SetFieldInfo(FieldInfo, Boolean)

Legt das FieldInfo für das zugrunde liegende CLR-Feld fest, das diese Eigenschaft verwenden soll.

(Geerbt von IConventionPropertyBase)
SetIsNullable(Nullable<Boolean>, Boolean)

Legt einen Wert fest, der angibt, ob diese Eigenschaft enthalten nullkann.

SetOrRemoveAnnotation(String, Object, Boolean)

Legt die unter dem angegebenen Namen gespeicherte Anmerkung fest. Überschreibt die vorhandene Anmerkung, wenn bereits eine Anmerkung mit dem angegebenen Namen vorhanden ist. Entfernt die vorhandene Anmerkung, falls null angegeben.

(Geerbt von IConventionAnnotatable)
SetPropertyAccessMode(Nullable<PropertyAccessMode>, Boolean)

Legt die PropertyAccessMode für diese Eigenschaft zu verwendende Eigenschaft fest.

(Geerbt von IConventionPropertyBase)
ToDebugString(MetadataDebugStringOptions, Int32)

Erstellt eine lesbare Darstellung der angegebenen Metadaten.

Warnung: Verlassen Sie sich nicht auf das Format der zurückgegebenen Zeichenfolge. Sie wurde nur für das Debuggen entwickelt und kann sich willkürlich zwischen Versionen ändern.

(Geerbt von IReadOnlyComplexProperty)

Erweiterungsmethoden

Name Beschreibung
GetJsonPropertyName(IReadOnlyComplexProperty)

Gibt den Eigenschaftennamen zurück, dem die Eigenschaft zugeordnet ist, wenn sie auf Cosmos ausgerichtet ist.

GetJsonPropertyName(IReadOnlyComplexProperty)

Ruft den Wert des JSON-Eigenschaftsnamens ab, der für die angegebene komplexe Eigenschaft einer Entität verwendet wird, die einer JSON-Spalte zugeordnet ist.

GetJsonPropertyNameConfigurationSource(IConventionComplexProperty)

Ruft den ConfigurationSource JSON-Eigenschaftsnamen für eine bestimmte komplexe Eigenschaft ab.

GetMappedStoreObjects(IReadOnlyComplexProperty, StoreObjectType)

Gibt die tabellenähnlichen Speicherobjekte zurück, denen diese komplexe Eigenschaft zugeordnet wird, wenn sie einer JSON-Spalte zugeordnet ist.

Diese Methode wird in der Regel von Datenbankanbietern (und anderen Erweiterungen) verwendet. Sie wird in der Regel nicht im Anwendungscode verwendet.

SetJsonPropertyName(IConventionComplexProperty, String, Boolean)

Legt den Wert des JSON-Eigenschaftsnamens fest, der für die angegebene komplexe Eigenschaft einer Entität verwendet wird, die einer JSON-Spalte zugeordnet ist.

Gilt für: