Class DateInputComponent

Namespace

Kentico.Xperience.Admin.Base.Forms

Assembly

Kentico.Xperience.Admin.Base.dll

Represents the Date input form component.

[ComponentAttribute(typeof(DateInputComponentAttribute))]
public sealed class DateInputComponent : DateTimeInputComponentBase<FormComponentProperties, DateInputClientProperties, DateTime?>, IFormComponent, IFormItem<IFormComponentClientProperties>, IFormItem

Inheritance

object

FormComponent<FormComponentProperties, DateInputClientProperties, DateTime?>

DateTimeInputComponentBase<FormComponentProperties, DateInputClientProperties, DateTime?>

DateInputComponent

Implements

IFormComponent

IFormItem<IFormComponentClientProperties>

IFormItem

Inherited Members

FormComponent<FormComponentProperties, DateInputClientProperties, DateTime?>.AddValidationRule(IValidationRule)

FormComponent<FormComponentProperties, DateInputClientProperties, DateTime?>.AddAdditionalAction(IAdditionalAction)

FormComponent<FormComponentProperties, DateInputClientProperties, DateTime?>.AddVisibilityCondition(IVisibilityCondition)

FormComponent<FormComponentProperties, DateInputClientProperties, DateTime?>.GetValue()

FormComponent<FormComponentProperties, DateInputClientProperties, DateTime?>.SetValue(DateTime?)

FormComponent<FormComponentProperties, DateInputClientProperties, DateTime?>.GetClientProperties()

FormComponent<FormComponentProperties, DateInputClientProperties, DateTime?>.BindContext(IFormContext)

FormComponent<FormComponentProperties, DateInputClientProperties, DateTime?>.ClientComponentName

FormComponent<FormComponentProperties, DateInputClientProperties, DateTime?>.Properties

FormComponent<FormComponentProperties, DateInputClientProperties, DateTime?>.FormContext

FormComponent<FormComponentProperties, DateInputClientProperties, DateTime?>.Name

FormComponent<FormComponentProperties, DateInputClientProperties, DateTime?>.Guid

FormComponent<FormComponentProperties, DateInputClientProperties, DateTime?>.Required

FormComponent<FormComponentProperties, DateInputClientProperties, DateTime?>.HasDependencies

FormComponent<FormComponentProperties, DateInputClientProperties, DateTime?>.ValidationRules

FormComponent<FormComponentProperties, DateInputClientProperties, DateTime?>.VisibilityConditions

FormComponent<FormComponentProperties, DateInputClientProperties, DateTime?>.AdditionalActions

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

FormItemExtensions.IsValid(IFormItem)

FormItemExtensions.IsVisible(IFormItem)

Constructors

DateInputComponent(ILocalizationService, IDateTimeNowService)

Creates a new instance of DateInputComponent.

public DateInputComponent(ILocalizationService localizationService, IDateTimeNowService dateTimeService)

Parameters

localizationService ILocalizationService

dateTimeService IDateTimeNowService

Fields

IDENTIFIER

Represents the DateInputComponent identifier.

public const string IDENTIFIER = "Kentico.Administration.DateInput"

Field Value

string

Properties

ClientComponentName

Name of the front-end type implementing the UI form component.

public override string ClientComponentName { get; }

Property Value

string

Methods

SetValue(DateTime?)

Sets the value of the form component.

public override void SetValue(DateTime? value)

Parameters

value DateTime?

Value to be set.

Remarks

The value can be additionally modified for component usage. Component is fully configured when method is called.

ValidateDateValue(ValidateDateValueCommandArguments)

A command that validates whether the provided string is in a expected Date format.

[FormComponentCommand]
[Obsolete("Serverside validation of 'DateInputComponent' is being deprecated.")]
public Task<ICommandResponse<ValidateDateValueCommandResult>> ValidateDateValue(ValidateDateValueCommandArguments arguments)

Parameters

arguments ValidateDateValueCommandArguments

The arguments of the command.

Returns

Task<ICommandResponse<ValidateDateValueCommandResult>>