Class MultipleObjectSelectorBase<TProperties, TSingleItemValue>

Namespace

Kentico.Xperience.Admin.Base.Forms

Assembly

Kentico.Xperience.Admin.Base.dll

Base class for the Object selector form component which allows to select multiple items.

public abstract class MultipleObjectSelectorBase<TProperties, TSingleItemValue> : ObjectSelectorBase<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>, TSingleItemValue>, IFormComponent, IFormItem<IFormComponentClientProperties>, IFormItem where TProperties : ObjectSelectorProperties, new()

Type Parameters

TProperties

Component properties type.

TSingleItemValue

A CLR type of a value element the form component operates with.

Inheritance

object

FormComponent<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>>

ObjectSelectorBase<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>, TSingleItemValue>

MultipleObjectSelectorBase<TProperties, TSingleItemValue>

Implements

IFormComponent

IFormItem<IFormComponentClientProperties>

IFormItem

Derived

ObjectCodeNameSelectorComponent

ObjectGuidSelectorComponent

ObjectIdSelectorComponent

ObjectSelectorComponent

FormSelectorComponent

Inherited Members

ObjectSelectorBase<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>, TSingleItemValue>.LoadObjects(LoadObjectsCommandArgs, CancellationToken)

ObjectSelectorBase<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>, TSingleItemValue>.LoadSelectedObjects(LoadSelectedObjectsCommandArgs<TSingleItemValue>, CancellationToken)

ObjectSelectorBase<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>, TSingleItemValue>.ConfigureClientProperties(ObjectSelectorClientProperties<TSingleItemValue>)

ObjectSelectorBase<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>, TSingleItemValue>.ConvertFormComponentValue(IEnumerable<TSingleItemValue>)

ObjectSelectorBase<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>, TSingleItemValue>.ConvertFormComponentSingleItemValue(IEnumerable<TSingleItemValue>)

ObjectSelectorBase<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>, TSingleItemValue>.ExtractValue(IDataContainer, ObjectTypeInfo)

ObjectSelectorBase<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>, TSingleItemValue>.GetSelectedObjects()

ObjectSelectorBase<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>, TSingleItemValue>.GetValidValueCollection()

FormComponent<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>>.ClientComponentName

FormComponent<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>>.Properties

FormComponent<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>>.FormContext

FormComponent<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>>.Name

FormComponent<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>>.Guid

FormComponent<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>>.Required

FormComponent<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>>.HasDependencies

FormComponent<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>>.ValidationRules

FormComponent<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>>.VisibilityConditions

FormComponent<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>>.AdditionalActions

FormComponent<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>>.AddValidationRule(IValidationRule)

FormComponent<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>>.AddAdditionalAction(IAdditionalAction)

FormComponent<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>>.AddVisibilityCondition(IVisibilityCondition)

FormComponent<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>>.GetValue()

FormComponent<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>>.SetValue(IEnumerable<TSingleItemValue>)

FormComponent<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>>.ConfigureComponent()

FormComponent<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>>.ResponseFrom<TResult>(TResult)

FormComponent<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>>.ConfigureClientProperties(ObjectSelectorClientProperties<TSingleItemValue>)

FormComponent<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>>.GetClientProperties()

FormComponent<TProperties, ObjectSelectorClientProperties<TSingleItemValue>, IEnumerable<TSingleItemValue>>.BindContext(IFormContext)

Extension Methods

FormItemExtensions.IsValid(IFormItem)

FormItemExtensions.IsVisible(IFormItem)

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

MultipleObjectSelectorBase(IObjectsRetriever, IObjectSelectorWhereConditionProviderActivator, ILocalizationService)

Constructor.

protected MultipleObjectSelectorBase(IObjectsRetriever objectsRetriever, IObjectSelectorWhereConditionProviderActivator whereConditionProviderActivator, ILocalizationService localizationService)

Parameters

objectsRetriever IObjectsRetriever

Objects retriever.

whereConditionProviderActivator IObjectSelectorWhereConditionProviderActivator

WHERE condition provider activator.

localizationService ILocalizationService

Localization service.

Exceptions

ArgumentNullException

If objectsRetriever, whereConditionProviderActivator or localizationService is null.

Properties

ClientComponentName

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

public override string ClientComponentName { get; }

Property Value

string

Methods

ConfigureClientProperties(ObjectSelectorClientProperties<TSingleItemValue>)

Configures the form component client properties.

protected override Task ConfigureClientProperties(ObjectSelectorClientProperties<TSingleItemValue> clientProperties)

Parameters

clientProperties ObjectSelectorClientProperties<TSingleItemValue>

The current instance of the form component client properties.

Returns

Task

Remarks

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

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.

ConvertFormComponentSingleItemValue(IEnumerable<TSingleItemValue>)

Extracts an array of selected object identifiers from a collection containing items of a the TSingleItemValue type.

protected override IEnumerable<string> ConvertFormComponentSingleItemValue(IEnumerable<TSingleItemValue> value)

Parameters

value IEnumerable<TSingleItemValue>

Component value.

Returns

IEnumerable<string>