Class ValidationResult

Namespace

Kentico.Xperience.Admin.Base.Forms

Assembly

Kentico.Xperience.Admin.Base.dll

Represents the result of a validation.

public sealed class ValidationResult

Inheritance

object

ValidationResult

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

ValidationResult(bool, string)

Initializes a new instance of the ValidationResult class.

public ValidationResult(bool isValid, string errorMessage = null)

Parameters

isValid bool

A value indicating whether the validation passed or failed.

errorMessage string

Error message containing additional details of failed validation, or null.

Properties

ErrorMessage

Error message containing additional details of failed validation, or null.

public string ErrorMessage { get; }

Property Value

string

Fail

Validation result with IsValid flag set to false and no custom validation error message.

public static ValidationResult Fail { get; }

Property Value

ValidationResult

IsValid

A value indicating whether the validation passed or failed.

public bool IsValid { get; }

Property Value

bool

Success

Validation result with IsValid flag set to true and no custom validation error message.

public static ValidationResult Success { get; }

Property Value

ValidationResult

Methods

FailResult(string)

Validation result as a Task with IsValid flag set to false and no custom validation error message.

public static Task<ValidationResult> FailResult(string errorMessage = null)

Parameters

errorMessage string

Error message containing additional details of failed validation, or null.

Returns

Task<ValidationResult>

SuccessResult()

Validation result as a Task with IsValid flag set to true and no custom validation error message.

public static Task<ValidationResult> SuccessResult()

Returns

Task<ValidationResult>

See Also

ValidationRule<TProperties, TClientProperties, TValue>