Class DateTimeStringComponent

Namespace

Kentico.Xperience.Admin.Base.Forms

Assembly

Kentico.Xperience.Admin.Base.dll

Represents a component with a read-only DateTime value.

[ComponentAttribute(typeof(DateTimeStringComponentAttribute))]
public sealed class DateTimeStringComponent : FormComponent<DateTimeStringProperties, DateTimeStringClientProperties, DateTime?>, IFormComponent, IFormItem<IFormComponentClientProperties>, IFormItem

Inheritance

object

FormComponent<DateTimeStringProperties, DateTimeStringClientProperties, DateTime?>

DateTimeStringComponent

Implements

IFormComponent

IFormItem<IFormComponentClientProperties>

IFormItem

Inherited Members

FormComponent<DateTimeStringProperties, DateTimeStringClientProperties, DateTime?>.AddValidationRule(IValidationRule)

FormComponent<DateTimeStringProperties, DateTimeStringClientProperties, DateTime?>.AddAdditionalAction(IAdditionalAction)

FormComponent<DateTimeStringProperties, DateTimeStringClientProperties, DateTime?>.AddVisibilityCondition(IVisibilityCondition)

FormComponent<DateTimeStringProperties, DateTimeStringClientProperties, DateTime?>.GetValue()

FormComponent<DateTimeStringProperties, DateTimeStringClientProperties, DateTime?>.SetValue(DateTime?)

FormComponent<DateTimeStringProperties, DateTimeStringClientProperties, DateTime?>.GetClientProperties()

FormComponent<DateTimeStringProperties, DateTimeStringClientProperties, DateTime?>.BindContext(IFormContext)

FormComponent<DateTimeStringProperties, DateTimeStringClientProperties, DateTime?>.ClientComponentName

FormComponent<DateTimeStringProperties, DateTimeStringClientProperties, DateTime?>.Properties

FormComponent<DateTimeStringProperties, DateTimeStringClientProperties, DateTime?>.FormContext

FormComponent<DateTimeStringProperties, DateTimeStringClientProperties, DateTime?>.Name

FormComponent<DateTimeStringProperties, DateTimeStringClientProperties, DateTime?>.Guid

FormComponent<DateTimeStringProperties, DateTimeStringClientProperties, DateTime?>.Required

FormComponent<DateTimeStringProperties, DateTimeStringClientProperties, DateTime?>.HasDependencies

FormComponent<DateTimeStringProperties, DateTimeStringClientProperties, DateTime?>.ValidationRules

FormComponent<DateTimeStringProperties, DateTimeStringClientProperties, DateTime?>.VisibilityConditions

FormComponent<DateTimeStringProperties, DateTimeStringClientProperties, 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

DateTimeStringComponent()

public DateTimeStringComponent()

Fields

CLIENT_COMPONENT_NAME

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

public const string CLIENT_COMPONENT_NAME = "@kentico/xperience-admin-base/DateTimeString"

Field Value

string

IDENTIFIER

Represents the DateTimeStringComponent identifier.

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

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(DateTimeStringClientProperties)

Configures the form component client properties.

protected override Task ConfigureClientProperties(DateTimeStringClientProperties clientProperties)

Parameters

clientProperties DateTimeStringClientProperties

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.