Class GeneralSelectorComponent

Namespace

Kentico.Xperience.Admin.Base.Forms

Assembly

Kentico.Xperience.Admin.Base.dll

Enables user to select one or more items from a set of items. It uses the same client component as ObjectSelectorComponent. A set of available items is defined by DataProvider.

[ComponentAttribute(typeof(GeneralSelectorComponentAttribute))]
public sealed class GeneralSelectorComponent : GeneralSelectorComponentBase<GeneralSelectorProperties, ObjectSelectorClientProperties<string>, IEnumerable<string>>, IFormComponent, IFormItem<IFormComponentClientProperties>, IFormItem

Inheritance

object

FormComponent<GeneralSelectorProperties, ObjectSelectorClientProperties<string>, IEnumerable<string>>

GeneralSelectorComponentBase<GeneralSelectorProperties, ObjectSelectorClientProperties<string>, IEnumerable<string>>

GeneralSelectorComponent

Implements

IFormComponent

IFormItem<IFormComponentClientProperties>

IFormItem

Inherited Members

FormComponent<GeneralSelectorProperties, ObjectSelectorClientProperties<string>, IEnumerable<string>>.ClientComponentName

FormComponent<GeneralSelectorProperties, ObjectSelectorClientProperties<string>, IEnumerable<string>>.Properties

FormComponent<GeneralSelectorProperties, ObjectSelectorClientProperties<string>, IEnumerable<string>>.FormContext

FormComponent<GeneralSelectorProperties, ObjectSelectorClientProperties<string>, IEnumerable<string>>.Name

FormComponent<GeneralSelectorProperties, ObjectSelectorClientProperties<string>, IEnumerable<string>>.Guid

FormComponent<GeneralSelectorProperties, ObjectSelectorClientProperties<string>, IEnumerable<string>>.Required

FormComponent<GeneralSelectorProperties, ObjectSelectorClientProperties<string>, IEnumerable<string>>.HasDependencies

FormComponent<GeneralSelectorProperties, ObjectSelectorClientProperties<string>, IEnumerable<string>>.ValidationRules

FormComponent<GeneralSelectorProperties, ObjectSelectorClientProperties<string>, IEnumerable<string>>.VisibilityConditions

FormComponent<GeneralSelectorProperties, ObjectSelectorClientProperties<string>, IEnumerable<string>>.AdditionalActions

FormComponent<GeneralSelectorProperties, ObjectSelectorClientProperties<string>, IEnumerable<string>>.AddValidationRule(IValidationRule)

FormComponent<GeneralSelectorProperties, ObjectSelectorClientProperties<string>, IEnumerable<string>>.AddAdditionalAction(IAdditionalAction)

FormComponent<GeneralSelectorProperties, ObjectSelectorClientProperties<string>, IEnumerable<string>>.AddVisibilityCondition(IVisibilityCondition)

FormComponent<GeneralSelectorProperties, ObjectSelectorClientProperties<string>, IEnumerable<string>>.GetValue()

FormComponent<GeneralSelectorProperties, ObjectSelectorClientProperties<string>, IEnumerable<string>>.SetValue(IEnumerable<string>)

FormComponent<GeneralSelectorProperties, ObjectSelectorClientProperties<string>, IEnumerable<string>>.GetClientProperties()

FormComponent<GeneralSelectorProperties, ObjectSelectorClientProperties<string>, IEnumerable<string>>.BindContext(IFormContext)

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

FormItemExtensions.IsValid(IFormItem)

FormItemExtensions.IsVisible(IFormItem)

Remarks

The component requires a IGeneralSelectorDataProvider implementation to provide items available to a user.

Constructors

GeneralSelectorComponent(IHttpContextAccessor, ILocalizationService)

Constructor.

public GeneralSelectorComponent(IHttpContextAccessor httpContextAccessor, ILocalizationService localizationService)

Parameters

httpContextAccessor IHttpContextAccessor

HTTP context accessor.

localizationService ILocalizationService

Localization service.

Properties

ClientComponentName

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

public override string ClientComponentName { get; }

Property Value

string

Methods

ConfigureClientProperties(ObjectSelectorClientProperties<string>)

Configures the form component client properties.

protected override Task ConfigureClientProperties(ObjectSelectorClientProperties<string> clientProperties)

Parameters

clientProperties ObjectSelectorClientProperties<string>

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<string>)

Extracts an array of selected object identifiers (of string type) from a collection containing items of a the string type.

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

Parameters

value IEnumerable<string>

Component value.

Returns

IEnumerable<string>

ConvertFormComponentValue(IEnumerable<string>)

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<string> value)

Parameters

value IEnumerable<string>

Component value.

Returns

IEnumerable<string>