Table of Contents

Class MaxLengthValidationRule

Namespace
Kentico.Xperience.Admin.Base.Forms
Assembly
Kentico.Xperience.Admin.Base.dll

Validates whether value satisfies the MaxLength limit.

[ValidationRuleAttribute(typeof(MaxLengthValidationRuleAttribute))]
public sealed class MaxLengthValidationRule : ValidationRule<MaxLengthValidationRuleProperties, MaxLengthValidationRuleClientProperties, string>, IValidationRule
Inheritance
object
MaxLengthValidationRule
Implements
Inherited Members
Extension Methods

Constructors

MaxLengthValidationRule(ILocalizationService)

Creates a new instance of MaxLengthValidationRule class.

public MaxLengthValidationRule(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(MaxLengthValidationRuleClientProperties)

Allows set validation rule client properties.

protected override Task ConfigureClientProperties(MaxLengthValidationRuleClientProperties clientProperties)

Parameters

clientProperties MaxLengthValidationRuleClientProperties

Current instance of client properties.

Returns

Task

Validate(string, IFormFieldValueProvider)

Validates whether value's length is less than or equal to MaxLength.

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

Parameters

value string

Value to be validated.

formFieldValueProvider IFormFieldValueProvider

Provider of values of other form fields for contextual validation.

Returns

Task<ValidationResult>

Returns the validation result.

Remarks

Null value is treated as zero length.