Class ObjectSelectorComponent

Namespace

Kentico.Xperience.Admin.Base.Forms

Assembly

Kentico.Xperience.Admin.Base.dll

Object selector form component.

[ComponentAttribute(typeof(ObjectSelectorComponentAttribute))]
public sealed class ObjectSelectorComponent : 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>

ObjectSelectorComponent

Implements

IFormComponent

IFormItem<IFormComponentClientProperties>

IFormItem

Inherited Members

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)

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

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>>.GetClientProperties()

FormComponent<ObjectSelectorProperties, ObjectSelectorClientProperties<ObjectRelatedItem>, IEnumerable<ObjectRelatedItem>>.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

ObjectSelectorComponent(IObjectsRetriever, IObjectSelectorWhereConditionProviderActivator, ILocalizationService)

Constructor.

public ObjectSelectorComponent(IObjectsRetriever objectsRetriever, IObjectSelectorWhereConditionProviderActivator whereConditionProviderActivator, ILocalizationService localizationService)

Parameters

objectsRetriever IObjectsRetriever

Objects retriever.

whereConditionProviderActivator IObjectSelectorWhereConditionProviderActivator

WHERE condition provider activator.

localizationService ILocalizationService

Localization service.

Methods

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