Table of Contents

Class SmartFolderSelectorComponent

Namespace
Kentico.Xperience.Admin.Base.Forms
Assembly
Kentico.Xperience.Admin.Base.dll

Represents a form component for selecting smart folder.

[ComponentAttribute(typeof(SmartFolderSelectorComponentAttribute))]
public sealed class SmartFolderSelectorComponent : FormComponentWithNestedComponents<SmartFolderSelectorProperties, SmartFolderSelectorClientProperties, SmartFolderReference>, IFormComponent, IFormItem<IFormComponentClientProperties>, IFormItem
Inheritance
object
SmartFolderSelectorComponent
Implements
Inherited Members
Extension Methods

Constructors

SmartFolderSelectorComponent(IFormComponentCommandInvoker, IFormDataBinder, IInfoProvider<SmartFolderInfo>, IPageLinkGenerator, IContentLanguageRetriever, ILocalizationService, IReusableFieldSchemaManager, IServiceProvider, IEventLogService)

Initializes a new instance of the SmartFolderSelectorComponent class.

public SmartFolderSelectorComponent(IFormComponentCommandInvoker formComponentCommandInvoker, IFormDataBinder formDataBinder, IInfoProvider<SmartFolderInfo> smartFoldersProvider, IPageLinkGenerator pageLinkGenerator, IContentLanguageRetriever contentLanguageRetriever, ILocalizationService localizationService, IReusableFieldSchemaManager reusableFieldSchemaManager, IServiceProvider serviceProvider, IEventLogService eventLogService)

Parameters

formComponentCommandInvoker IFormComponentCommandInvoker
formDataBinder IFormDataBinder
smartFoldersProvider IInfoProvider<SmartFolderInfo>
pageLinkGenerator IPageLinkGenerator
contentLanguageRetriever IContentLanguageRetriever
localizationService ILocalizationService
reusableFieldSchemaManager IReusableFieldSchemaManager
serviceProvider IServiceProvider
eventLogService IEventLogService

Fields

IDENTIFIER

Represents the SmartFolderSelectorComponent identifier.

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

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

Change(FormSubmissionCommandArguments, CancellationToken)

Handles the form change command. The command is invoked whenever visibility conditions or form component configurators of the form need to be reevaluated to re-render the form.

public Task<ICommandResponse<FilterFormChangeResult>> Change(FormSubmissionCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args FormSubmissionCommandArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<FilterFormChangeResult>>

ChangeCreateSmartFolderForm(FormSubmissionCommandArguments, CancellationToken)

Handles the create smart folder form change command. The command is invoked whenever visibility conditions or form component configurators of the form need to be reevaluated to re-render the form.

public Task<ICommandResponse<FilterFormChangeResult>> ChangeCreateSmartFolderForm(FormSubmissionCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args FormSubmissionCommandArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<FilterFormChangeResult>>

ConfigureClientProperties(SmartFolderSelectorClientProperties)

Configures the form component client properties.

protected override Task ConfigureClientProperties(SmartFolderSelectorClientProperties clientProperties)

Parameters

clientProperties SmartFolderSelectorClientProperties

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.

CreateSmartFolder(CreateSmartFolderArguments, CancellationToken)

Routes the command to the CreateDeliverableSmartFolder(CreateSmartFolderArguments, int, CancellationToken) method.

public Task<ICommandResponse<CreateSmartFolderResult>> CreateSmartFolder(CreateSmartFolderArguments args, CancellationToken cancellationToken)

Parameters

args CreateSmartFolderArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<CreateSmartFolderResult>>

CreateSmartFolderConfirmFilter(CreateSmartFolderConfirmFilterArguments, CancellationToken)

Routes the command to the CreateSmartFolderConfirmFilter(CreateSmartFolderConfirmFilterArguments, CancellationToken, int?, bool) method.

public Task<ICommandResponse<CreateSmartFolderConfirmFilterResult>> CreateSmartFolderConfirmFilter(CreateSmartFolderConfirmFilterArguments args, CancellationToken cancellationToken)

Parameters

args CreateSmartFolderConfirmFilterArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<CreateSmartFolderConfirmFilterResult>>

GetFolder(GetSmartFolderRequest, CancellationToken)

Retrieves smart folder.

public Task<ICommandResponse<GetSmartFolderResult>> GetFolder(GetSmartFolderRequest args, CancellationToken cancellationToken)

Parameters

args GetSmartFolderRequest
cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetSmartFolderResult>>

GetFolders(GetSmartFoldersRequest, CancellationToken)

Retrieves all valid smart folders.

public Task<ICommandResponse<GetSmartFoldersResult>> GetFolders(GetSmartFoldersRequest args, CancellationToken cancellationToken)

Parameters

args GetSmartFoldersRequest
cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetSmartFoldersResult>>

GetFormItemsForCreateSmartFolder(CancellationToken)

Routes the command to the Kentico.Xperience.Admin.Base.ISmartFolderCommandManager.GetFormItemsForCreateDeliverableSmartFolder(System.Threading.CancellationToken) method.

public Task<ICommandResponse<GetFormItemsForCreateSmartFolderResult>> GetFormItemsForCreateSmartFolder(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetFormItemsForCreateSmartFolderResult>>

GetNestedFormItems()

Returns the form items that are used within the nested form.

protected override Task<ICollection<IFormItem>> GetNestedFormItems()

Returns

Task<ICollection<IFormItem>>

GetSmartFolderFilterDescription(GetSmartFolderFilterDescriptionArguments, CancellationToken)

Retrieves metadata for the smart folder filter.

public Task<ICommandResponse<GetSmartFolderFilterDescriptionResult>> GetSmartFolderFilterDescription(GetSmartFolderFilterDescriptionArguments args, CancellationToken cancellationToken = default)

Parameters

args GetSmartFolderFilterDescriptionArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetSmartFolderFilterDescriptionResult>>

InitializeNestedContext()

Initializes form context within the nested form.

protected override Task<IFormContext> InitializeNestedContext()

Returns

Task<IFormContext>

LoadSmartFolderData(LoadSmartFolderDataCommandArguments, CancellationToken)

Routes the command to the LoadDataForSmartFolderSelector(int, IEnumerable<Guid>, IEnumerable<Guid>, LoadSmartFolderDataCommandArguments, CancellationToken) method.

public Task<ICommandResponse<LoadDataResult>> LoadSmartFolderData(LoadSmartFolderDataCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args LoadSmartFolderDataCommandArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<LoadDataResult>>

LoadSmartFolderListingConfiguration(CancellationToken)

Routes the command to the Kentico.Xperience.Admin.Base.IContentListingCommandManager.LoadListingConfigurationForSmartFolderSelector(int, int, System.Threading.CancellationToken) method.

public Task<ICommandResponse<LoadListingConfigurationCommandResult>> LoadSmartFolderListingConfiguration(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<ICommandResponse<LoadListingConfigurationCommandResult>>