Validator.ValidateObjectAsync 方法

定义

命名空间:

System.ComponentModel.DataAnnotations

程序集:

System.ComponentModel.Annotations.dll

重载

名称	说明
ValidateObjectAsync(Object, ValidationContext, CancellationToken)	如果给定instance无效，则异步引发 aValidationException。
ValidateObjectAsync(Object, ValidationContext, Boolean, CancellationToken)	如果给定的对象实例无效，则异步引发 a ValidationException 。

ValidateObjectAsync(Object, ValidationContext, CancellationToken)

Source:

Validator.cs

如果给定instance无效，则异步引发 aValidationException。

[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

参数

instance

Object

要测试的对象实例。 它不能 null。

validationContext

ValidationContext

描述要验证的对象，并为验证程序提供服务和上下文。

cancellationToken

CancellationToken

等待任务完成时观察的 A CancellationToken 。

返回

Task

表示 Task 异步验证操作。

属性

RequiresUnreferencedCodeAttribute

例外

ArgumentNullException

何时 instance 为 null。

ArgumentNullException

何时 validationContext 为 null。

ArgumentException

何时instance与 on validationContext不匹配ObjectInstance。

ValidationException

何时 instance 发现无效。

OperationCanceledException

验证操作已取消。

注解

此方法检查 RequiredAttribute 对象属性的属性。 如果属性验证成功，该方法将评估 ValidationAttribute 附加到对象类型的属性。

此重载不评估其他属性级验证属性。 若要评估这些属性，请调用接受 validateAllProperties 该参数设置为 true的重载。

验证分三个阶段运行：属性验证、类型级属性验证和对象级验证。 仅当前面的阶段成功时，每个阶段才会运行。 对象级验证更倾向于在实现时调用 ValidateAsync(ValidationContext, CancellationToken) ，而 Validate(ValidationContext) 对于仅实现同步接口的对象，则作为回退。 它不调用这两者。

ValidateObjectAsync(Object, ValidationContext, Boolean, CancellationToken)

Source:

Validator.cs

如果给定的对象实例无效，则异步引发 a ValidationException 。

[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

参数

instance

Object

要测试的对象实例。 它不能 null。

validationContext

ValidationContext

描述要验证的对象，并为验证程序提供服务和上下文。

validateAllProperties

Boolean

如果 true，还验证所有 instance属性。

cancellationToken

CancellationToken

等待任务完成时观察的 A CancellationToken 。

返回

Task

表示 Task 异步验证操作。

属性

RequiresUnreferencedCodeAttribute

例外

ArgumentNullException

何时 instance 为 null。

ArgumentNullException

何时 validationContext 为 null。

ArgumentException

何时instance与 on validationContext不匹配ObjectInstance。

ValidationException

何时 instance 发现无效。

OperationCanceledException

验证操作已取消。

注解

此方法检查 RequiredAttribute 对象属性的属性，即使 validateAllProperties 为 false. 如果属性验证成功，该方法将评估 ValidationAttribute 附加到对象类型的属性。

true如果是validateAllProperties，该方法还会评估对象直接属性上的其他验证属性。 此过程不会以递归方式验证属性值。

验证分三个阶段运行：属性验证、类型级属性验证和对象级验证。 仅当前面的阶段成功时，每个阶段才会运行。 对象级验证更倾向于在实现时调用 ValidateAsync(ValidationContext, CancellationToken) ，而 Validate(ValidationContext) 对于仅实现同步接口的对象，则作为回退。 它不调用这两者。