Validator.ValidateObjectAsync Metoda
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Przeciążenia
| Nazwisko | Opis |
|---|---|
| ValidateObjectAsync(Object, ValidationContext, CancellationToken) |
Asynchronicznie zgłasza wartość ValidationException , jeśli dana |
| ValidateObjectAsync(Object, ValidationContext, Boolean, CancellationToken) |
Asynchronicznie zgłasza błąd ValidationException , jeśli dane wystąpienie obiektu jest nieprawidłowe. |
ValidateObjectAsync(Object, ValidationContext, CancellationToken)
- Źródło:
- Validator.cs
Asynchronicznie zgłasza wartość ValidationException , jeśli dana instance wartość jest nieprawidłowa.
[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
Parametry
- instance
- Object
Wystąpienie obiektu do przetestowania. Nie można go null.
- validationContext
- ValidationContext
Opisuje weryfikowany obiekt i udostępnia usługi i kontekst modułów sprawdzania poprawności.
- cancellationToken
- CancellationToken
Element do CancellationToken obserwowania podczas oczekiwania na ukończenie zadania.
Zwraca
Reprezentująca Task operację asynchronicznej weryfikacji.
- Atrybuty
Wyjątki
Gdy instance ma wartość null.
Gdy validationContext ma wartość null.
Gdy instance element nie jest zgodny z parametrem ObjectInstance w dniu validationContext.
Gdy instance okaże się, że jest on nieprawidłowy.
Operacja walidacji została anulowana.
Uwagi
Ta metoda sprawdza RequiredAttribute atrybuty we właściwościach obiektu. Jeśli walidacja właściwości zakończy się pomyślnie, metoda ocenia ValidationAttribute atrybuty dołączone do typu obiektu.
To przeciążenie nie ocenia innych atrybutów weryfikacji na poziomie właściwości. Aby ocenić te atrybuty, wywołaj przeciążenie, które akceptuje validateAllProperties z tym argumentem ustawionym na truewartość .
Walidacja jest uruchamiana w trzech etapach: walidacja właściwości, walidacja atrybutu na poziomie typu i walidacja na poziomie obiektu. Każdy etap jest uruchamiany tylko wtedy, gdy poprzednie etapy się powiedzie. Walidacja na poziomie obiektu preferuje wywołanie ValidateAsync(ValidationContext, CancellationToken) podczas implementacji, z Validate(ValidationContext) jako rezerwą dla obiektów, które implementują tylko interfejs synchroniczny. Nie wywołuje obu tych elementów.
Dotyczy
ValidateObjectAsync(Object, ValidationContext, Boolean, CancellationToken)
- Źródło:
- Validator.cs
Asynchronicznie zgłasza błąd ValidationException , jeśli dane wystąpienie obiektu jest nieprawidłowe.
[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
Parametry
- instance
- Object
Wystąpienie obiektu do przetestowania. Nie można go null.
- validationContext
- ValidationContext
Opisuje weryfikowany obiekt i udostępnia usługi i kontekst modułów sprawdzania poprawności.
- validateAllProperties
- Boolean
Jeśli trueparametr jest również weryfikowany przez wszystkie instancewłaściwości .
- cancellationToken
- CancellationToken
Element do CancellationToken obserwowania podczas oczekiwania na ukończenie zadania.
Zwraca
Reprezentująca Task operację asynchronicznej weryfikacji.
- Atrybuty
Wyjątki
Gdy instance ma wartość null.
Gdy validationContext ma wartość null.
Gdy instance element nie jest zgodny z parametrem ObjectInstance w dniu validationContext.
Gdy instance okaże się, że jest on nieprawidłowy.
Operacja walidacji została anulowana.
Uwagi
Ta metoda sprawdza RequiredAttribute atrybuty właściwości obiektu nawet wtedy, gdy validateAllProperties ma wartość false. Jeśli walidacja właściwości zakończy się pomyślnie, metoda ocenia ValidationAttribute atrybuty dołączone do typu obiektu.
Jeśli validateAllProperties parametr ma truewartość , metoda ocenia również inne atrybuty walidacji w właściwościach natychmiastowych obiektu. Ten proces nie rekursywnie weryfikuje wartości właściwości.
Walidacja jest uruchamiana w trzech etapach: walidacja właściwości, walidacja atrybutu na poziomie typu i walidacja na poziomie obiektu. Każdy etap jest uruchamiany tylko wtedy, gdy poprzednie etapy się powiedzie. Walidacja na poziomie obiektu preferuje wywołanie ValidateAsync(ValidationContext, CancellationToken) podczas implementacji, z Validate(ValidationContext) jako rezerwą dla obiektów, które implementują tylko interfejs synchroniczny. Nie wywołuje obu tych elementów.