Język

Validator.TryValidatePropertyAsync Metoda

Definicja

Asynchronicznie sprawdza, czy dana wartość właściwości jest prawidłowa.

[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("The Type of validationContext.ObjectType cannot be statically discovered.")]
public static System.Threading.Tasks.Task<bool> TryValidatePropertyAsync(object? value, System.ComponentModel.DataAnnotations.ValidationContext validationContext, System.Collections.Generic.ICollection<System.ComponentModel.DataAnnotations.ValidationResult>? validationResults, System.Threading.CancellationToken cancellationToken = default);
[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("The Type of validationContext.ObjectType cannot be statically discovered.")>]
static member TryValidatePropertyAsync : obj * System.ComponentModel.DataAnnotations.ValidationContext * System.Collections.Generic.ICollection<System.ComponentModel.DataAnnotations.ValidationResult> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>
Public Shared Function TryValidatePropertyAsync (value As Object, validationContext As ValidationContext, validationResults As ICollection(Of ValidationResult), Optional cancellationToken As CancellationToken = Nothing) As Task(Of Boolean)

Parametry

value
Object

Testowana wartość.

validationContext
ValidationContext

Opisuje element członkowski właściwości do weryfikowania i świadczenia usług i kontekstu dla modułów sprawdzania poprawności.

validationResults
ICollection<ValidationResult>

Opcjonalna kolekcja, która odbiera błędy walidacji jako ValidationResult wystąpienia.

cancellationToken
CancellationToken

Element do CancellationToken obserwowania podczas oczekiwania na ukończenie zadania.

Zwraca

Wartość Task<TResult> jest true prawidłowa, false jeśli wystąpią jakiekolwiek błędy walidacji.

Atrybuty

Wyjątki

validationContext jest nullwartością lub MemberName jest null pusta.

MemberName nie identyfikuje prawidłowej właściwości publicznej, innej niż indeksator lub value nie może być przypisana do tej właściwości.

Operacja walidacji została anulowana.

Uwagi

Ta metoda testuje każdą ValidationAttribute skojarzona z właściwością zidentyfikowaną przez validationContext. Jeśli validationResults parametr ma wartość inną niż null, ta metoda dodaje do niej element ValidationResult dla każdego niepowodzenia walidacji.

Jeśli właściwość znajduje RequiredAttribute się w obiekcie, zostanie ona obliczona przed wszystkimi innymi atrybutami weryfikacji. Jeśli wymagany moduł sprawdzania poprawności zakończy się niepowodzeniem, walidacja zostanie zatrzymana, dodanie pojedynczego błędu validationResults do kolekcji, jeśli ma to zastosowanie i zwrócenie elementu false.

Wszystkie AsyncValidationAttribute wystąpienia są oceniane asynchronicznie po przekazaniu wszystkich atrybutów weryfikacji synchronicznej.

Dotyczy