Class TagSelectorComponent

Namespace

Kentico.Xperience.Admin.Base.Forms

Assembly

Kentico.Xperience.Admin.Base.dll

Represents tag selector form component.

[ComponentAttribute(typeof(TagSelectorComponentAttribute))]
public sealed class TagSelectorComponent : FormComponent<TagSelectorProperties, TagSelectorClientProperties, IEnumerable<TagReference>>, IFormComponent, IFormItem<IFormComponentClientProperties>, IFormItem

Inheritance

object

FormComponent<TagSelectorProperties, TagSelectorClientProperties, IEnumerable<TagReference>>

TagSelectorComponent

Implements

IFormComponent

IFormItem<IFormComponentClientProperties>

IFormItem

Inherited Members

FormComponent<TagSelectorProperties, TagSelectorClientProperties, IEnumerable<TagReference>>.ClientComponentName

FormComponent<TagSelectorProperties, TagSelectorClientProperties, IEnumerable<TagReference>>.Properties

FormComponent<TagSelectorProperties, TagSelectorClientProperties, IEnumerable<TagReference>>.FormContext

FormComponent<TagSelectorProperties, TagSelectorClientProperties, IEnumerable<TagReference>>.Name

FormComponent<TagSelectorProperties, TagSelectorClientProperties, IEnumerable<TagReference>>.Guid

FormComponent<TagSelectorProperties, TagSelectorClientProperties, IEnumerable<TagReference>>.Required

FormComponent<TagSelectorProperties, TagSelectorClientProperties, IEnumerable<TagReference>>.HasDependencies

FormComponent<TagSelectorProperties, TagSelectorClientProperties, IEnumerable<TagReference>>.ValidationRules

FormComponent<TagSelectorProperties, TagSelectorClientProperties, IEnumerable<TagReference>>.VisibilityConditions

FormComponent<TagSelectorProperties, TagSelectorClientProperties, IEnumerable<TagReference>>.AdditionalActions

FormComponent<TagSelectorProperties, TagSelectorClientProperties, IEnumerable<TagReference>>.AddValidationRule(IValidationRule)

FormComponent<TagSelectorProperties, TagSelectorClientProperties, IEnumerable<TagReference>>.AddAdditionalAction(IAdditionalAction)

FormComponent<TagSelectorProperties, TagSelectorClientProperties, IEnumerable<TagReference>>.AddVisibilityCondition(IVisibilityCondition)

FormComponent<TagSelectorProperties, TagSelectorClientProperties, IEnumerable<TagReference>>.GetValue()

FormComponent<TagSelectorProperties, TagSelectorClientProperties, IEnumerable<TagReference>>.SetValue(IEnumerable<TagReference>)

FormComponent<TagSelectorProperties, TagSelectorClientProperties, IEnumerable<TagReference>>.GetClientProperties()

FormComponent<TagSelectorProperties, TagSelectorClientProperties, IEnumerable<TagReference>>.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

TagSelectorComponent(IInfoProvider<TaxonomyInfo>, ILocalizationService, IContentLanguageRetriever, IPageLinkGenerator)

Initializes a new instance of TagSelectorComponent

public TagSelectorComponent(IInfoProvider<TaxonomyInfo> taxonomyInfoProvider, ILocalizationService localizationService, IContentLanguageRetriever contentLanguageRetriever, IPageLinkGenerator pageLinkGenerator)

Parameters

taxonomyInfoProvider IInfoProvider<TaxonomyInfo>

localizationService ILocalizationService

contentLanguageRetriever IContentLanguageRetriever

pageLinkGenerator IPageLinkGenerator

Fields

IDENTIFIER

Represents the TagSelectorComponent identifier.

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

Field Value

string

Properties

ClientComponentName

Represents the client component name.

public override string ClientComponentName { get; }

Property Value

string

Methods

ConfigureClientProperties(TagSelectorClientProperties)

Configures the form component client properties.

protected override Task ConfigureClientProperties(TagSelectorClientProperties clientProperties)

Parameters

clientProperties TagSelectorClientProperties

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.

LoadTaxonomyTreeItems(CancellationToken)

Loads tag selector panel items.

public Task<ICommandResponse<LoadTaxonomyTreeItemsResult>> LoadTaxonomyTreeItems(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task<ICommandResponse<LoadTaxonomyTreeItemsResult>>