Class FormSelectorComponent

Namespace

Kentico.Xperience.Admin.DigitalMarketing.Forms

Assembly

Kentico.Xperience.Admin.DigitalMarketing.dll

Form selector form component.

[ComponentAttribute(typeof(FormSelectorComponentAttribute))]
public class FormSelectorComponent : MultipleObjectSelectorBase<ObjectSelectorProperties, ObjectRelatedItem>, IFormComponent, IFormItem<IFormComponentClientProperties>, IFormItem

Inheritance

object

FormComponent<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>>

ObjectSelectorBase<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>, ObjectRelatedItem>

MultipleObjectSelectorBase<ObjectSelectorProperties, ObjectRelatedItem>

FormSelectorComponent

Implements

IFormComponent

IFormItem<IFormComponentClientProperties>

IFormItem

Inherited Members

MultipleObjectSelectorBase<ObjectSelectorProperties, ObjectRelatedItem>.ConfigureComponent()

MultipleObjectSelectorBase<ObjectSelectorProperties, ObjectRelatedItem>.ConfigureClientProperties(ObjectSelectorClientProperties<ObjectRelatedItem>)

MultipleObjectSelectorBase<ObjectSelectorProperties, ObjectRelatedItem>.ConvertFormComponentSingleItemValue(IEnumerable<ObjectRelatedItem>)

MultipleObjectSelectorBase<ObjectSelectorProperties, ObjectRelatedItem>.ClientComponentName

ObjectSelectorBase<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>, ObjectRelatedItem>.LoadObjects(LoadObjectsCommandArgs, CancellationToken)

ObjectSelectorBase<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>, ObjectRelatedItem>.LoadSelectedObjects(LoadSelectedObjectsCommandArgs<ObjectRelatedItem>, CancellationToken)

ObjectSelectorBase<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>, ObjectRelatedItem>.ConfigureClientProperties(ObjectSelectorClientProperties<ObjectRelatedItem>)

ObjectSelectorBase<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>, ObjectRelatedItem>.ConvertFormComponentValue(IEnumerable<ObjectRelatedItem>)

ObjectSelectorBase<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>, ObjectRelatedItem>.ConvertFormComponentSingleItemValue(IEnumerable<ObjectRelatedItem>)

ObjectSelectorBase<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>, ObjectRelatedItem>.ExtractValue(IDataContainer, ObjectTypeInfo)

ObjectSelectorBase<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>, ObjectRelatedItem>.GetSelectedObjects()

ObjectSelectorBase<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>, ObjectRelatedItem>.GetValidValueCollection()

FormComponent<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>>.AddValidationRule(IValidationRule)

FormComponent<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>>.AddAdditionalAction(IAdditionalAction)

FormComponent<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>>.AddVisibilityCondition(IVisibilityCondition)

FormComponent<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>>.GetValue()

FormComponent<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>>.SetValue(IEnumerable<ObjectRelatedItem>)

FormComponent<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>>.ConfigureComponent()

FormComponent<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>>.ResponseFrom<TResult>(TResult)

FormComponent<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>>.ConfigureClientProperties(ObjectSelectorClientProperties<ObjectRelatedItem>)

FormComponent<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>>.GetClientProperties()

FormComponent<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>>.BindContext(IFormContext)

FormComponent<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>>.ClientComponentName

FormComponent<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>>.Properties

FormComponent<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>>.FormContext

FormComponent<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>>.Name

FormComponent<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>>.Guid

FormComponent<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>>.Required

FormComponent<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>>.HasDependencies

FormComponent<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>>.ValidationRules

FormComponent<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>>.VisibilityConditions

FormComponent<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>>.AdditionalActions

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

FormSelectorComponent(IObjectsRetriever, IObjectSelectorWhereConditionProviderActivator, ILocalizationService, IPageLinkGenerator, IInfoProvider<BizFormInfo>)

Initializes an instance of FormSelectorComponent class.

public FormSelectorComponent(IObjectsRetriever objectsRetriever, IObjectSelectorWhereConditionProviderActivator whereConditionProviderActivator, ILocalizationService localizationService, IPageLinkGenerator pageLinkGenerator, IInfoProvider<BizFormInfo> bizFormInfoProvider)

Parameters

objectsRetriever IObjectsRetriever

whereConditionProviderActivator IObjectSelectorWhereConditionProviderActivator

localizationService ILocalizationService

pageLinkGenerator IPageLinkGenerator

bizFormInfoProvider IInfoProvider<BizFormInfo>

Properties

ClientComponentName

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

public override string ClientComponentName { get; }

Property Value

string

Methods

ConfigureComponent()

Configures the form component. This method is called when all form component properties are set.

protected override void ConfigureComponent()

Remarks

Override this method to set component inner state, like additional component validation rules.

ConvertFormComponentValue(IEnumerable<ObjectRelatedItem>)

Extracts an array of selected object identifiers from component value for the sake of providing selected objects meta data to the client component.

protected override IEnumerable<string> ConvertFormComponentValue(IEnumerable<ObjectRelatedItem> value)

Parameters

value IEnumerable<ObjectRelatedItem>

Component value.

Returns

IEnumerable<string>

ExtractValue(IDataContainer, ObjectTypeInfo)

Enables IObjectsRetriever to create an element from a source data.

protected override ObjectRelatedItem ExtractValue(IDataContainer dataContainer, ObjectTypeInfo typeInfo)

Parameters

dataContainer IDataContainer

Source data.

typeInfo ObjectTypeInfo

Type info.

Returns

ObjectRelatedItem

GetSelectedFormUrl(GetSelectedFormUrlCommandArgs)

Loads selected form URL for the edit button.

[FormComponentCommand]
public Task<ICommandResponse<GetSelectedFormUrlCommandResult>> GetSelectedFormUrl(GetSelectedFormUrlCommandArgs args)

Parameters

args GetSelectedFormUrlCommandArgs

Command arguments.

Returns

Task<ICommandResponse<GetSelectedFormUrlCommandResult>>