Class ObjectIdSelectorComponent

Namespace

Kentico.Xperience.Admin.Base.Forms

Assembly

Kentico.Xperience.Admin.Base.dll

Object id selector.

[ComponentAttribute(typeof(ObjectIdSelectorComponentAttribute))]
public sealed class ObjectIdSelectorComponent : MultipleObjectSelectorBase<ObjectSelectorProperties, int>, IFormComponent, IFormItem<IFormComponentClientProperties>, IFormItem

Inheritance

object

FormComponent<ObjectSelectorProperties, ObjectSelectorClientProperties<int>, IEnumerable<int>>

ObjectSelectorBase<ObjectSelectorProperties, ObjectSelectorClientProperties<int>, IEnumerable<int>, int>

MultipleObjectSelectorBase<ObjectSelectorProperties, int>

ObjectIdSelectorComponent

Implements

IFormComponent

IFormItem<IFormComponentClientProperties>

IFormItem

Inherited Members

MultipleObjectSelectorBase<ObjectSelectorProperties, int>.ClientComponentName

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ObjectIdSelectorComponent(IObjectsRetriever, IObjectSelectorWhereConditionProviderActivator, ILocalizationService)

Constructor.

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

Parameters

objectsRetriever IObjectsRetriever

Objects retriever.

whereConditionProviderActivator IObjectSelectorWhereConditionProviderActivator

WHERE condition provider activator.

localizationService ILocalizationService

Localization service.

Fields

IDENTIFIER

Object id selector identifier.

public const string IDENTIFIER = "Kentico.Administration.ObjectIdSelector"

Field 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<int>)

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

Parameters

value IEnumerable<int>

Component value.

Returns

IEnumerable<string>

ExtractValue(IDataContainer, ObjectTypeInfo)

Enables IObjectsRetriever to create an element from a source data.

protected override int ExtractValue(IDataContainer dataContainer, ObjectTypeInfo typeInfo)

Parameters

dataContainer IDataContainer

Source data.

typeInfo ObjectTypeInfo

Type info.

Returns

int