Class HeadlessItemSelectorComponent

Namespace

Kentico.Xperience.Admin.Headless.Forms

Assembly

Kentico.Xperience.Admin.Headless.dll

Represents headless item selector form component.

public sealed class HeadlessItemSelectorComponent : ContentItemSelectorComponentBase<HeadlessItemSelectorProperties>, IFormComponent, IFormItem<IFormComponentClientProperties>, IFormItem

Inheritance

object

FormComponent<HeadlessItemSelectorProperties, ContentItemSelectorClientProperties, IEnumerable<ContentItemReference>>

FormComponentWithNestedComponents<HeadlessItemSelectorProperties, ContentItemSelectorClientProperties, IEnumerable<ContentItemReference>>

ContentItemSelectorComponentBase<HeadlessItemSelectorProperties>

HeadlessItemSelectorComponent

Implements

IFormComponent

IFormItem<IFormComponentClientProperties>

IFormItem

Inherited Members

ContentItemSelectorComponentBase<HeadlessItemSelectorProperties>.ChangeEditContentItemPanelForm(FormChangeCommandArguments, CancellationToken)

ContentItemSelectorComponentBase<HeadlessItemSelectorProperties>.LoadContentItemPanelItems(LoadContentItemPanelItemsCommandArguments, CancellationToken)

ContentItemSelectorComponentBase<HeadlessItemSelectorProperties>.LoadFormItems(ContentItemCommandParameters, CancellationToken)

ContentItemSelectorComponentBase<HeadlessItemSelectorProperties>.Create(ContentItemSubmissionCommandArguments, CancellationToken)

ContentItemSelectorComponentBase<HeadlessItemSelectorProperties>.ConfirmSelection(ContentItemSubmissionCommandArguments, CancellationToken)

ContentItemSelectorComponentBase<HeadlessItemSelectorProperties>.Publish(ContentItemSubmissionCommandArguments, CancellationToken)

ContentItemSelectorComponentBase<HeadlessItemSelectorProperties>.ValidateDisplayName(RenameCommandArguments)

FormComponentWithNestedComponents<HeadlessItemSelectorProperties, ContentItemSelectorClientProperties, IEnumerable<ContentItemReference>>.ComponentCommand(FormComponentCommandModel, CancellationToken)

FormComponent<HeadlessItemSelectorProperties, ContentItemSelectorClientProperties, IEnumerable<ContentItemReference>>.AddValidationRule(IValidationRule)

FormComponent<HeadlessItemSelectorProperties, ContentItemSelectorClientProperties, IEnumerable<ContentItemReference>>.AddAdditionalAction(IAdditionalAction)

FormComponent<HeadlessItemSelectorProperties, ContentItemSelectorClientProperties, IEnumerable<ContentItemReference>>.AddVisibilityCondition(IVisibilityCondition)

FormComponent<HeadlessItemSelectorProperties, ContentItemSelectorClientProperties, IEnumerable<ContentItemReference>>.GetValue()

FormComponent<HeadlessItemSelectorProperties, ContentItemSelectorClientProperties, IEnumerable<ContentItemReference>>.SetValue(IEnumerable<ContentItemReference>)

FormComponent<HeadlessItemSelectorProperties, ContentItemSelectorClientProperties, IEnumerable<ContentItemReference>>.GetClientProperties()

FormComponent<HeadlessItemSelectorProperties, ContentItemSelectorClientProperties, IEnumerable<ContentItemReference>>.BindContext(IFormContext)

FormComponent<HeadlessItemSelectorProperties, ContentItemSelectorClientProperties, IEnumerable<ContentItemReference>>.ClientComponentName

FormComponent<HeadlessItemSelectorProperties, ContentItemSelectorClientProperties, IEnumerable<ContentItemReference>>.Properties

FormComponent<HeadlessItemSelectorProperties, ContentItemSelectorClientProperties, IEnumerable<ContentItemReference>>.FormContext

FormComponent<HeadlessItemSelectorProperties, ContentItemSelectorClientProperties, IEnumerable<ContentItemReference>>.Name

FormComponent<HeadlessItemSelectorProperties, ContentItemSelectorClientProperties, IEnumerable<ContentItemReference>>.Guid

FormComponent<HeadlessItemSelectorProperties, ContentItemSelectorClientProperties, IEnumerable<ContentItemReference>>.Required

FormComponent<HeadlessItemSelectorProperties, ContentItemSelectorClientProperties, IEnumerable<ContentItemReference>>.HasDependencies

FormComponent<HeadlessItemSelectorProperties, ContentItemSelectorClientProperties, IEnumerable<ContentItemReference>>.ValidationRules

FormComponent<HeadlessItemSelectorProperties, ContentItemSelectorClientProperties, IEnumerable<ContentItemReference>>.VisibilityConditions

FormComponent<HeadlessItemSelectorProperties, ContentItemSelectorClientProperties, IEnumerable<ContentItemReference>>.AdditionalActions

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

HeadlessItemSelectorComponent(IFormComponentCommandInvoker, IFormDataBinder, IAuthenticatedUserAccessor, IContentItemManagerFactory, IHeadlessItemManagerFactory, IHeadlessItemSelectorItemProvider, ILocalizationService, IEventLogService, IFormItemCollectionProvider, IContentLanguageRetriever, IContentItemDisplayNameValidator, IServiceProvider)

Initializes a new instance of HeadlessItemSelectorComponent.

public HeadlessItemSelectorComponent(IFormComponentCommandInvoker formComponentCommandInvoker, IFormDataBinder formDataBinder, IAuthenticatedUserAccessor userAccessor, IContentItemManagerFactory contentItemManagerFactory, IHeadlessItemManagerFactory headlessItemManagerFactory, IHeadlessItemSelectorItemProvider selectorItemProvider, ILocalizationService localizationService, IEventLogService eventLogService, IFormItemCollectionProvider formItemCollectionProvider, IContentLanguageRetriever contentLanguageRetriever, IContentItemDisplayNameValidator contentItemDisplayNameValidator, IServiceProvider serviceProvider)

Parameters

formComponentCommandInvoker IFormComponentCommandInvoker

formDataBinder IFormDataBinder

userAccessor IAuthenticatedUserAccessor

contentItemManagerFactory IContentItemManagerFactory

headlessItemManagerFactory IHeadlessItemManagerFactory

selectorItemProvider IHeadlessItemSelectorItemProvider

localizationService ILocalizationService

eventLogService IEventLogService

formItemCollectionProvider IFormItemCollectionProvider

contentLanguageRetriever IContentLanguageRetriever

contentItemDisplayNameValidator IContentItemDisplayNameValidator

serviceProvider IServiceProvider

Fields

IDENTIFIER

Represents the HeadlessItemSelectorComponent identifier.

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

Field Value

string

Properties

ClientComponentName

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

public override string ClientComponentName { get; }

Property Value

string

Methods

ConfigureClientProperties(ContentItemSelectorClientProperties)

Configures the form component client properties.

protected override Task ConfigureClientProperties(ContentItemSelectorClientProperties clientProperties)

Parameters

clientProperties ContentItemSelectorClientProperties

The current instance of the form component client properties.

Returns

Task

Remarks

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

CreateContentItem(ContentItemSubmissionCommandArguments, string, VersionStatus, ContentItemData, CancellationToken)

Creates a reusable content item based on provided parameters.

protected override Task<int> CreateContentItem(ContentItemSubmissionCommandArguments args, string languageName, VersionStatus versionStatus, ContentItemData data, CancellationToken cancellationToken)

Parameters

args ContentItemSubmissionCommandArguments

Submission arguments.

languageName string

Language code name.

versionStatus VersionStatus

Version status.

data ContentItemData

Content item data retrieved from form.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<int>

Content item identifier of newly created item.

Remarks

Method creates a reusable content item. If you want to create specific content type item you need to override this method.

GetContentTypeSelectionModel()

Returns the model object for the content type selection form.

protected override object GetContentTypeSelectionModel()

Returns

object