Validator.TryValidateObjectAsync Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Sobrecargas
| Nombre | Description |
|---|---|
| TryValidateObjectAsync(Object, ValidationContext, ICollection<ValidationResult>, CancellationToken) |
Comprueba de forma asincrónica si la instancia de objeto especificada es válida. |
| TryValidateObjectAsync(Object, ValidationContext, ICollection<ValidationResult>, Boolean, CancellationToken) |
Comprueba de forma asincrónica si la instancia de objeto especificada es válida. |
TryValidateObjectAsync(Object, ValidationContext, ICollection<ValidationResult>, CancellationToken)
- Source:
- Validator.cs
Comprueba de forma asincrónica si la instancia de objeto especificada es válida.
[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<bool> TryValidateObjectAsync(object instance, System.ComponentModel.DataAnnotations.ValidationContext validationContext, System.Collections.Generic.ICollection<System.ComponentModel.DataAnnotations.ValidationResult>? validationResults, 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 TryValidateObjectAsync : obj * System.ComponentModel.DataAnnotations.ValidationContext * System.Collections.Generic.ICollection<System.ComponentModel.DataAnnotations.ValidationResult> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>Public Shared Function TryValidateObjectAsync (instance As Object, validationContext As ValidationContext, validationResults As ICollection(Of ValidationResult), Optional cancellationToken As CancellationToken = Nothing) As Task(Of Boolean)Parámetros
- instance
- Object
Instancia de objeto que se va a probar. No se puede null.
- validationContext
- ValidationContext
Describe el objeto para validar y proporcionar servicios y contexto para los validadores.
- validationResults
- ICollection<ValidationResult>
Colección opcional que recibe errores de validación como ValidationResult instancias.
- cancellationToken
- CancellationToken
Que CancellationToken se debe observar mientras espera a que se complete la tarea.
Devoluciones
que Task<TResult> es true si el objeto es válido, false si se detectan errores de validación.
- Atributos
Excepciones
Cuando instance es null.
Cuando validationContext es null.
Cuando instance no coincide con en ObjectInstancevalidationContext.
Se canceló la operación de validación.
Comentarios
Este método evalúa todos los ValidationAttributeelementos adjuntos al tipo de la instancia de objeto. También comprueba que todas las propiedades marcadas con RequiredAttribute están establecidas. No valida los ValidationAttributes en propiedades individuales del objeto a menos TryValidateObjectAsync(Object, ValidationContext, ICollection<ValidationResult>, Boolean, CancellationToken) que se llame a con establecido en truevalidateAllProperties .
La validación se ejecuta en tres fases: validación de propiedades, validación de atributos de nivel de tipo y validación de nivel de objeto. Cada fase solo se ejecuta si las fases anteriores se realizan correctamente. La validación de nivel de objeto prefiere invocar ValidateAsync(ValidationContext, CancellationToken) cuando se implementa, con Validate(ValidationContext) como reserva para los objetos que implementan solo la interfaz sincrónica. No invoca ambos.
Se aplica a
TryValidateObjectAsync(Object, ValidationContext, ICollection<ValidationResult>, Boolean, CancellationToken)
- Source:
- Validator.cs
Comprueba de forma asincrónica si la instancia de objeto especificada es válida.
[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<bool> TryValidateObjectAsync(object instance, System.ComponentModel.DataAnnotations.ValidationContext validationContext, System.Collections.Generic.ICollection<System.ComponentModel.DataAnnotations.ValidationResult>? validationResults, 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 TryValidateObjectAsync : obj * System.ComponentModel.DataAnnotations.ValidationContext * System.Collections.Generic.ICollection<System.ComponentModel.DataAnnotations.ValidationResult> * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>Public Shared Function TryValidateObjectAsync (instance As Object, validationContext As ValidationContext, validationResults As ICollection(Of ValidationResult), validateAllProperties As Boolean, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Boolean)Parámetros
- instance
- Object
Instancia de objeto que se va a probar. No se puede null.
- validationContext
- ValidationContext
Describe el objeto para validar y proporcionar servicios y contexto para los validadores.
- validationResults
- ICollection<ValidationResult>
Colección opcional que recibe errores de validación como ValidationResult instancias.
- validateAllProperties
- Boolean
Si truees , también evalúa todas las propiedades del objeto (este proceso no es recursivo sobre las propiedades de las propiedades).
- cancellationToken
- CancellationToken
Que CancellationToken se debe observar mientras espera a que se complete la tarea.
Devoluciones
que Task<TResult> es true si el objeto es válido, false si se detectan errores de validación.
- Atributos
Excepciones
Cuando instance es null.
Cuando validationContext es null.
Cuando instance no coincide con en ObjectInstancevalidationContext.
Se canceló la operación de validación.
Comentarios
Este método evalúa todos los ValidationAttributeelementos adjuntos al tipo de la instancia de objeto. También comprueba que todas las propiedades marcadas con RequiredAttribute están establecidas. Si validateAllProperties es true, este método también evalúa los ValidationAttributes para todas las propiedades inmediatas de este objeto. Este proceso no es recursivo.
Cuando validateAllProperties es true, se inicia la validación para cada propiedad en secuencia. Los atributos sincrónicos de una propiedad se ejecutan antes de que se esperen los atributos asincrónicos de esa propiedad. La validación asincrónica que permanece en curso puede superponerse con la validación asincrónica para otras propiedades.
Cuando validationResults es null, la validación se detiene después del primer error de propiedad (cortocircuito entre propiedades). Los validadores asincrónicos en vuelo en otras propiedades se cancelan de forma cooperativa. Cuando validationResults no es NULL, se recopilan todas las propiedades y se recopilan todos los errores.
Devuelve Task<TResult> para la interoperabilidad con patrones de composición asincrónicos estándar, como Task.WhenAll y Task.WhenAny.
La validación se ejecuta en tres fases: validación de propiedades, validación de atributos de nivel de tipo y validación de nivel de objeto. Cada fase solo se ejecuta si las fases anteriores se realizan correctamente. La validación de nivel de objeto prefiere invocar ValidateAsync(ValidationContext, CancellationToken) cuando se implementa, con Validate(ValidationContext) como reserva para los objetos que implementan solo la interfaz sincrónica. No invoca ambos.
