Validator.ValidateObjectAsync Methode
Definitie
Belangrijk
Bepaalde informatie heeft betrekking op een voorlopige productversie die aanzienlijk kan worden gewijzigd voordat deze wordt uitgebracht. Microsoft biedt geen enkele expliciete of impliciete garanties met betrekking tot de informatie die hier wordt verstrekt.
Overloads
| Naam | Description |
|---|---|
| ValidateObjectAsync(Object, ValidationContext, CancellationToken) |
Asynchroon genereert een ValidationException als de opgegeven |
| ValidateObjectAsync(Object, ValidationContext, Boolean, CancellationToken) |
Asynchroon genereert een ValidationException als het opgegeven objectexemplaren ongeldig zijn. |
ValidateObjectAsync(Object, ValidationContext, CancellationToken)
- Bron:
- Validator.cs
Asynchroon genereert een ValidationException als de opgegeven instance waarde niet geldig is.
[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
Parameters
- instance
- Object
Het objectexemplaren dat moet worden getest. Het kan niet worden null.
- validationContext
- ValidationContext
Beschrijft het object dat wordt gevalideerd en services en context biedt voor de validators.
- cancellationToken
- CancellationToken
Een CancellationToken om te observeren terwijl wordt gewacht totdat de taak is voltooid.
Retouren
Een Task weergave van de asynchrone validatiebewerking.
- Kenmerken
Uitzonderingen
Wanneer instance is null.
Wanneer validationContext is null.
Wanneer instance komt dit niet overeen met de ObjectInstance on validationContext.
Wanneer instance blijkt dat deze ongeldig is.
De validatiebewerking is geannuleerd.
Opmerkingen
Met deze methode worden de RequiredAttribute kenmerken van de eigenschappen van het object gecontroleerd. Als de eigenschapsvalidatie slaagt, evalueert de methode de ValidationAttribute kenmerken die zijn gekoppeld aan het type van het object.
Deze overbelasting evalueert geen andere validatiekenmerken op eigenschapsniveau. Als u deze kenmerken wilt evalueren, roept u de overbelasting aan die accepteert validateAllProperties met dat argument ingesteld op true.
Validatie wordt uitgevoerd in drie fasen: eigenschapsvalidatie, kenmerkvalidatie op typeniveau en validatie op objectniveau. Elke fase wordt alleen uitgevoerd als de voorgaande fasen slagen. Validatie op objectniveau geeft de voorkeur aan aanroepen ValidateAsync(ValidationContext, CancellationToken) wanneer deze wordt geïmplementeerd, met Validate(ValidationContext) als een terugval voor objecten die alleen de synchrone interface implementeren. Beide worden niet aangeroepen.
Van toepassing op
ValidateObjectAsync(Object, ValidationContext, Boolean, CancellationToken)
- Bron:
- Validator.cs
Asynchroon genereert een ValidationException als het opgegeven objectexemplaren ongeldig zijn.
[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
Parameters
- instance
- Object
Het objectexemplaren dat moet worden getest. Het kan niet worden null.
- validationContext
- ValidationContext
Beschrijft het object dat wordt gevalideerd en services en context biedt voor de validators.
- validateAllProperties
- Boolean
Als true, ook valideert alle eigenschappen van de instance.
- cancellationToken
- CancellationToken
Een CancellationToken om te observeren terwijl wordt gewacht totdat de taak is voltooid.
Retouren
Een Task weergave van de asynchrone validatiebewerking.
- Kenmerken
Uitzonderingen
Wanneer instance is null.
Wanneer validationContext is null.
Wanneer instance komt dit niet overeen met de ObjectInstance on validationContext.
Wanneer instance blijkt dat deze ongeldig is.
De validatiebewerking is geannuleerd.
Opmerkingen
Met deze methode worden de kenmerken van de RequiredAttribute eigenschappen van het object gecontroleerd, zelfs wanneer validateAllProperties dit het object is false. Als de eigenschapsvalidatie slaagt, evalueert de methode de ValidationAttribute kenmerken die zijn gekoppeld aan het type van het object.
Als validateAllProperties dat het is true, evalueert de methode ook andere validatiekenmerken op de directe eigenschappen van het object. Met dit proces worden eigenschapswaarden niet recursief gevalideerd.
Validatie wordt uitgevoerd in drie fasen: eigenschapsvalidatie, kenmerkvalidatie op typeniveau en validatie op objectniveau. Elke fase wordt alleen uitgevoerd als de voorgaande fasen slagen. Validatie op objectniveau geeft de voorkeur aan aanroepen ValidateAsync(ValidationContext, CancellationToken) wanneer deze wordt geïmplementeerd, met Validate(ValidationContext) als een terugval voor objecten die alleen de synchrone interface implementeren. Beide worden niet aangeroepen.