Langue

Validator.ValidateObjectAsync Méthode

Définition

Surcharges

Nom Description
ValidateObjectAsync(Object, ValidationContext, CancellationToken)

Lève de façon asynchrone une ValidationException valeur si l’élément donné instance n’est pas valide.

ValidateObjectAsync(Object, ValidationContext, Boolean, CancellationToken)

Lève de façon asynchrone une ValidationException instance d’objet donnée si l’instance d’objet donnée n’est pas valide.

ValidateObjectAsync(Object, ValidationContext, CancellationToken)

Source:
Validator.cs

Lève de façon asynchrone une ValidationException valeur si l’élément donné instance n’est pas valide.

[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

Paramètres

instance
Object

Instance d’objet à tester. Il ne peut pas être null.

validationContext
ValidationContext

Décrit l’objet en cours de validation et fournit des services et un contexte pour les validateurs.

cancellationToken
CancellationToken

À CancellationToken observer lors de l’attente de la fin de la tâche.

Retours

Représentant Task l’opération de validation asynchrone.

Attributs

Exceptions

Quand instance est null.

Quand validationContext est null.

Quand instance ne correspond pas à l’on ObjectInstancevalidationContext.

Lorsqu’il instance est détecté qu’il n’est pas valide.

L’opération de validation a été annulée.

Remarques

Cette méthode vérifie les attributs sur les RequiredAttribute propriétés de l’objet. Si la validation de propriété réussit, la méthode évalue les ValidationAttribute attributs attachés au type de l’objet.

Cette surcharge n’évalue pas d’autres attributs de validation au niveau de la propriété. Pour évaluer ces attributs, appelez la surcharge qui accepte validateAllProperties avec cet argument défini truesur .

La validation s’exécute en trois étapes : validation des propriétés, validation d’attribut au niveau du type et validation au niveau de l’objet. Chaque étape s’exécute uniquement si les étapes précédentes réussissent. La validation au niveau de l’objet préfère appeler ValidateAsync(ValidationContext, CancellationToken) en cas d’implémentation, avec Validate(ValidationContext) comme secours pour les objets qui implémentent uniquement l’interface synchrone. Il n’appelle pas les deux.

S’applique à

ValidateObjectAsync(Object, ValidationContext, Boolean, CancellationToken)

Source:
Validator.cs

Lève de façon asynchrone une ValidationException instance d’objet donnée si l’instance d’objet donnée n’est pas valide.

[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

Paramètres

instance
Object

Instance d’objet à tester. Il ne peut pas être null.

validationContext
ValidationContext

Décrit l’objet en cours de validation et fournit des services et un contexte pour les validateurs.

validateAllProperties
Boolean

Si true, valide également toutes les propriétés de l’objet instance.

cancellationToken
CancellationToken

À CancellationToken observer lors de l’attente de la fin de la tâche.

Retours

Représentant Task l’opération de validation asynchrone.

Attributs

Exceptions

Quand instance est null.

Quand validationContext est null.

Quand instance ne correspond pas à l’on ObjectInstancevalidationContext.

Lorsqu’il instance est détecté qu’il n’est pas valide.

L’opération de validation a été annulée.

Remarques

Cette méthode vérifie les attributs sur les RequiredAttribute propriétés de l’objet, même si c’est falsele casvalidateAllProperties. Si la validation de propriété réussit, la méthode évalue les ValidationAttribute attributs attachés au type de l’objet.

Si validateAllProperties c’est truele cas, la méthode évalue également d’autres attributs de validation sur les propriétés immédiates de l’objet. Ce processus ne valide pas de manière récursive les valeurs de propriété.

La validation s’exécute en trois étapes : validation des propriétés, validation d’attribut au niveau du type et validation au niveau de l’objet. Chaque étape s’exécute uniquement si les étapes précédentes réussissent. La validation au niveau de l’objet préfère appeler ValidateAsync(ValidationContext, CancellationToken) en cas d’implémentation, avec Validate(ValidationContext) comme secours pour les objets qui implémentent uniquement l’interface synchrone. Il n’appelle pas les deux.

S’applique à