Class FormComponentConfigurator<TFormComponent>

Namespace

Kentico.Xperience.Admin.Base.Forms

Assembly

Kentico.Xperience.Admin.Base.dll

Represents a IFormComponent configurator which is used to configure a form component instance defined by FormComponentConfigurationAttribute.

public abstract class FormComponentConfigurator<TFormComponent> : IFormComponentConfigurator where TFormComponent : IFormComponent

Type Parameters

TFormComponent

Type of the form component to configure.

Inheritance

object

FormComponentConfigurator<TFormComponent>

Implements

IFormComponentConfigurator

Derived

StateConfigurator

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Properties

DependencyFieldName

Name of the dependency field which will trigger the configurator when changed.

[Obsolete("Use DependencyFieldNames instead.")]
[ObsoleteSince(28, 4)]
public string DependencyFieldName { get; }

Property Value

string

DependencyFieldNames

Names of the dependency fields which will trigger the configurator when changed.

public IEnumerable<string> DependencyFieldNames { get; }

Property Value

IEnumerable<string>

Methods

Configure(TFormComponent, IFormFieldValueProvider, CancellationToken)

Configures the form component.

public virtual Task Configure(TFormComponent formComponent, IFormFieldValueProvider formFieldValueProvider, CancellationToken cancellationToken)

Parameters

formComponent TFormComponent

Form component to configure.

formFieldValueProvider IFormFieldValueProvider

Provider of previous form field values.

cancellationToken CancellationToken

The cancellation instruction.

Returns

Task

Remarks

This method can not be used to set value of form component. Use ConfigureValue(IFormFieldValueProvider, string, CancellationToken) instead.

ConfigureValue(IFormFieldValueProvider, string, CancellationToken)

Sets value of form component.

public virtual Task<object> ConfigureValue(IFormFieldValueProvider formFieldValueProvider, string changedFieldName, CancellationToken cancellationToken)

Parameters

formFieldValueProvider IFormFieldValueProvider

Provider of previous form field values.

changedFieldName string

Name of the field whose change triggered the configurator, null if configurator was not triggered by field change.

cancellationToken CancellationToken

The cancellation instruction.

Returns

Task<object>

Remarks

The value returned by this function will be set to the configured component.