Sprache

Validator.ValidateObjectAsync Methode

Definition

Überlädt

Name Beschreibung
ValidateObjectAsync(Object, ValidationContext, CancellationToken)

Löst asynchron ein ValidationException , wenn der angegebene instance Wert ungültig ist.

ValidateObjectAsync(Object, ValidationContext, Boolean, CancellationToken)

Löst asynchron ein ValidationException , wenn die angegebene Objektinstanz ungültig ist.

ValidateObjectAsync(Object, ValidationContext, CancellationToken)

Quelle:
Validator.cs

Löst asynchron ein ValidationException , wenn der angegebene instance Wert ungültig ist.

[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Constructing a ValidationContext without a display name is not trim-safe because it uses reflection to discover the type of the instance being validated in order to resolve the DisplayNameAttribute when a display name is not provided.")]
public static System.Threading.Tasks.Task ValidateObjectAsync(object instance, System.ComponentModel.DataAnnotations.ValidationContext validationContext, System.Threading.CancellationToken cancellationToken = default);
[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Constructing a ValidationContext without a display name is not trim-safe because it uses reflection to discover the type of the instance being validated in order to resolve the DisplayNameAttribute when a display name is not provided.")>]
static member ValidateObjectAsync : obj * System.ComponentModel.DataAnnotations.ValidationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Shared Function ValidateObjectAsync (instance As Object, validationContext As ValidationContext, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameter

instance
Object

Die zu testde Objektinstanz. Es kann nicht nullwerden.

validationContext
ValidationContext

Beschreibt das überprüfte Objekt und stellt Dienste und Kontext für die Validatoren bereit.

cancellationToken
CancellationToken

A CancellationToken , um zu beobachten, während sie auf den Abschluss der Aufgabe warten.

Gibt zurück

Eine Task Darstellung des asynchronen Überprüfungsvorgangs.

Attribute

Ausnahmen

Wann instance ist null.

Wann validationContext ist null.

Wenn instance dies nicht mit der EinvalidationContext-ObjectInstance/Aus-Methode übereinstimmt.

Wenn instance gefunden wird, dass sie ungültig ist.

Der Überprüfungsvorgang wurde abgebrochen.

Hinweise

Diese Methode überprüft die RequiredAttribute Attribute für die Eigenschaften des Objekts. Wenn die Eigenschaftenüberprüfung erfolgreich ist, wertet die Methode die Attribute aus, die ValidationAttribute dem Objekttyp zugeordnet sind.

Diese Überladung wertet keine anderen Überprüfungsattribute auf Eigenschaftsebene aus. Um diese Attribute auszuwerten, rufen Sie die Überladung validateAllProperties auf, die mit diesem Argument akzeptiert wird.true

Die Überprüfung wird in drei Phasen ausgeführt: Eigenschaftenüberprüfung, Attributüberprüfung auf Typebene und Überprüfung auf Objektebene. Jede Phase wird nur ausgeführt, wenn die vorherigen Phasen erfolgreich sind. Bei der Überprüfung auf Objektebene wird bevorzugt ValidateAsync(ValidationContext, CancellationToken) , wenn sie implementiert wird, mit Validate(ValidationContext) einem Fallback für Objekte, die nur die synchrone Schnittstelle implementieren. Beides wird nicht aufgerufen.

Gilt für:

ValidateObjectAsync(Object, ValidationContext, Boolean, CancellationToken)

Quelle:
Validator.cs

Löst asynchron ein ValidationException , wenn die angegebene Objektinstanz ungültig ist.

[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Constructing a ValidationContext without a display name is not trim-safe because it uses reflection to discover the type of the instance being validated in order to resolve the DisplayNameAttribute when a display name is not provided.")]
public static System.Threading.Tasks.Task ValidateObjectAsync(object instance, System.ComponentModel.DataAnnotations.ValidationContext validationContext, bool validateAllProperties, System.Threading.CancellationToken cancellationToken = default);
[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Constructing a ValidationContext without a display name is not trim-safe because it uses reflection to discover the type of the instance being validated in order to resolve the DisplayNameAttribute when a display name is not provided.")>]
static member ValidateObjectAsync : obj * System.ComponentModel.DataAnnotations.ValidationContext * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Shared Function ValidateObjectAsync (instance As Object, validationContext As ValidationContext, validateAllProperties As Boolean, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameter

instance
Object

Die zu testde Objektinstanz. Es kann nicht nullwerden.

validationContext
ValidationContext

Beschreibt das überprüfte Objekt und stellt Dienste und Kontext für die Validatoren bereit.

validateAllProperties
Boolean

If true, also validates all the instance's properties.

cancellationToken
CancellationToken

A CancellationToken , um zu beobachten, während sie auf den Abschluss der Aufgabe warten.

Gibt zurück

Eine Task Darstellung des asynchronen Überprüfungsvorgangs.

Attribute

Ausnahmen

Wann instance ist null.

Wann validationContext ist null.

Wenn instance dies nicht mit der EinvalidationContext-ObjectInstance/Aus-Methode übereinstimmt.

Wenn instance gefunden wird, dass sie ungültig ist.

Der Überprüfungsvorgang wurde abgebrochen.

Hinweise

Diese Methode überprüft die RequiredAttribute Attribute für die Eigenschaften des Objekts, auch wenn validateAllProperties dies der Fall ist false. Wenn die Eigenschaftenüberprüfung erfolgreich ist, wertet die Methode die Attribute aus, die ValidationAttribute dem Objekttyp zugeordnet sind.

Wenn validateAllProperties ja true, wertet die Methode auch andere Überprüfungsattribute für die unmittelbaren Eigenschaften des Objekts aus. Bei diesem Vorgang werden Eigenschaftswerte nicht rekursiv überprüft.

Die Überprüfung wird in drei Phasen ausgeführt: Eigenschaftenüberprüfung, Attributüberprüfung auf Typebene und Überprüfung auf Objektebene. Jede Phase wird nur ausgeführt, wenn die vorherigen Phasen erfolgreich sind. Bei der Überprüfung auf Objektebene wird bevorzugt ValidateAsync(ValidationContext, CancellationToken) , wenn sie implementiert wird, mit Validate(ValidationContext) einem Fallback für Objekte, die nur die synchrone Schnittstelle implementieren. Beides wird nicht aufgerufen.

Gilt für: