Language

Validator.TryValidatePropertyAsync メソッド

定義

指定されたプロパティ値が有効かどうかを非同期的にテストします。

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

パラメーター

value
Object

検定する値を指定します。

validationContext
ValidationContext

検証するプロパティ メンバーについて説明し、検証コントロールのサービスとコンテキストを提供します。

validationResults
ICollection<ValidationResult>

ValidationResult インスタンスとして検証エラーを受け取る省略可能なコレクション。

cancellationToken
CancellationToken

タスクの完了を待機している間に観察する CancellationToken 。

返品

値が有効な場合にtrueされるTask<TResult>。検証エラーが発生した場合にfalse。

属性

例外

validationContext が null、または MemberName が null または空です。

MemberName では、有効なパブリック プロパティ、非インデクサー プロパティが識別されないか、 value をそのプロパティに割り当てることができません。

検証操作が取り消されました。

注釈

このメソッドは、validationContextによって識別されるプロパティに関連付けられている各ValidationAttributeをテストします。 validationResultsが null 以外の場合、このメソッドは検証エラーごとにValidationResultを追加します。

プロパティに RequiredAttribute が見つかった場合は、他のすべての検証属性の前に評価されます。 必要な検証が失敗した場合、検証が停止し、該当する場合は validationResults コレクションにその単一のエラーが追加され、 falseが返されます。

すべての AsyncValidationAttribute インスタンスは、すべての同期検証属性が渡された後に非同期的に評価されます。

適用対象