Class MaximumIntegerValueValidationRule

Namespace

Kentico.Xperience.Admin.Base.Forms

Assembly

Kentico.Xperience.Admin.Base.dll

Validates whether value satisfies the MaxValue limit.

[ValidationRuleAttribute(typeof(MaximumIntegerValueValidationRuleAttribute))]
public sealed class MaximumIntegerValueValidationRule : ValidationRule<MaximumIntegerValueValidationRuleProperties, MaximumIntegerValueValidationRuleClientProperties, int?>, IValidationRule

Inheritance

object

ValidationRule<MaximumIntegerValueValidationRuleProperties, MaximumIntegerValueValidationRuleClientProperties, int?>

MaximumIntegerValueValidationRule

Implements

IValidationRule

Inherited Members

ValidationRule<MaximumIntegerValueValidationRuleProperties, MaximumIntegerValueValidationRuleClientProperties, int?>.Properties

ValidationRule<MaximumIntegerValueValidationRuleProperties, MaximumIntegerValueValidationRuleClientProperties, int?>.ClientRuleName

ValidationRule<MaximumIntegerValueValidationRuleProperties, MaximumIntegerValueValidationRuleClientProperties, int?>.Result

ValidationRule<MaximumIntegerValueValidationRuleProperties, MaximumIntegerValueValidationRuleClientProperties, int?>.Validate(int?, IFormFieldValueProvider)

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

MaximumIntegerValueValidationRule(ILocalizationService)

Creates a new instance of MaximumIntegerValueValidationRule class.

public MaximumIntegerValueValidationRule(ILocalizationService localizationService)

Parameters

localizationService ILocalizationService

Properties

ClientRuleName

Gets the client rule name identifier.

public override string ClientRuleName { get; }

Property Value

string

DefaultErrorMessage

Defines default error message of the validation rule.

protected override string DefaultErrorMessage { get; }

Property Value

string

ErrorMessageFormatter

Defines a formatter function for error message.

protected override Func<string, string> ErrorMessageFormatter { get; }

Property Value

Func<string, string>

Remarks

Formatter is applied for DefaultErrorMessage or ErrorMessage. The custom error message defined by ErrorMessage is considered as a localized and formatted by the caller.

Methods

ConfigureClientProperties(MaximumIntegerValueValidationRuleClientProperties)

Allows set validation rule client properties.

protected override Task ConfigureClientProperties(MaximumIntegerValueValidationRuleClientProperties clientProperties)

Parameters

clientProperties MaximumIntegerValueValidationRuleClientProperties

Current instance of client properties.

Returns

Task

Validate(int?, IFormFieldValueProvider)

Validates whether value is less than or equal to MaxValue.

public override Task<ValidationResult> Validate(int? value, IFormFieldValueProvider formFieldValueProvider)

Parameters

value int?

Value to be validated.

formFieldValueProvider IFormFieldValueProvider

Provider of values of other form fields for contextual validation.

Returns

Task<ValidationResult>

Validation result object.