Validator.TryValidatePropertyAsync Metode

Definisi

Ruang nama:

System.ComponentModel.DataAnnotations

Rakitan:

System.ComponentModel.Annotations.dll

Sumber:

Validator.cs

Secara asinkron menguji apakah nilai properti yang diberikan valid.

[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)

Parameter

value

Object

Nilai untuk menguji.

validationContext

ValidationContext

Menjelaskan anggota properti untuk memvalidasi dan menyediakan layanan dan konteks untuk validator.

validationResults

ICollection<ValidationResult>

Koleksi opsional yang menerima kegagalan validasi sebagai ValidationResult instans.

cancellationToken

CancellationToken

A CancellationToken untuk mengamati sambil menunggu tugas selesai.

Mengembalikan

Task<Boolean>

Task<TResult> Yang true jika nilainya valid, false jika ada kesalahan validasi yang ditemui.

Atribut

RequiresUnreferencedCodeAttribute

Pengecualian

ArgumentNullException

validationContext adalah null, atau MemberName atau null kosong.

ArgumentException

MemberName tidak mengidentifikasi properti publik, non-pengindeks yang valid, atau value tidak dapat ditetapkan ke properti tersebut.

OperationCanceledException

Operasi validasi dibatalkan.

Keterangan

Metode ini menguji masing-masing ValidationAttribute yang terkait dengan properti yang diidentifikasi oleh validationContext. Jika validationResults non-null, metode ini menambahkan ValidationResult ke dalamnya untuk setiap kegagalan validasi.

Jika ada yang RequiredAttribute ditemukan di properti, properti dievaluasi sebelum semua atribut validasi lainnya. Jika validator yang diperlukan gagal, validasi berhenti, menambahkan kegagalan tunggal tersebut ke validationResults koleksi saat berlaku dan mengembalikan false.

Setiap AsyncValidationAttribute instans dievaluasi secara asinkron setelah semua atribut validasi sinkron berlalu.