Table of Contents

Class DateTimeInputComponent

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

Represents the DateTime input form component.

[ComponentAttribute(typeof(DateTimeInputComponentAttribute))]
public sealed class DateTimeInputComponent : DateTimeInputComponentBase<FormComponentProperties, DateTimeInputClientProperties, DateTime?>, IFormComponent, IFormItem<IFormComponentClientProperties>, IFormItem
Inheritance
object
DateTimeInputComponentBase<FormComponentProperties, DateTimeInputClientProperties, DateTime?>
DateTimeInputComponent
Implements
Inherited Members
Extension Methods

Constructors

DateTimeInputComponent(ILocalizationService, IDateTimeNowService)

Creates a new instance of DateTimeInputComponent.

public DateTimeInputComponent(ILocalizationService localizationService, IDateTimeNowService dateTimeService)

Parameters

localizationService ILocalizationService
dateTimeService IDateTimeNowService

Fields

IDENTIFIER

Represents the DateTimeInputComponent identifier.

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

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

ConfigureClientProperties(DateTimeInputClientProperties)

Configures the form component client properties.

protected override Task ConfigureClientProperties(DateTimeInputClientProperties clientProperties)

Parameters

clientProperties DateTimeInputClientProperties

The current instance of the form component client properties.

Returns

Task

Remarks

Override this method in order to configure form component client properties.

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.

ValidateDateTimeValue(ValidateDateTimeValueCommandArguments)

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

[Obsolete("Serverside validation of 'DateTimeInputComponent' is being deprecated.")]
[FormComponentCommand]
public Task<ICommandResponse<ValidateDateTimeValueCommandResult>> ValidateDateTimeValue(ValidateDateTimeValueCommandArguments arguments)

Parameters

arguments ValidateDateTimeValueCommandArguments

The arguments of the command.

Returns

Task<ICommandResponse<ValidateDateTimeValueCommandResult>>

ValidateDateValue(ValidateDateTimeValueCommandArguments)

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

[Obsolete("Serverside validation of 'DateTimeInputComponent' is being deprecated.")]
public Task<ICommandResponse<ValidateDateTimeValueCommandResult>> ValidateDateValue(ValidateDateTimeValueCommandArguments arguments)

Parameters

arguments ValidateDateTimeValueCommandArguments

The arguments of the command.

Returns

Task<ICommandResponse<ValidateDateTimeValueCommandResult>>