Class SmartFolderSelectorComponent
Represents a form component for selecting smart folder.
[ComponentAttribute(typeof(SmartFolderSelectorComponentAttribute))]
public sealed class SmartFolderSelectorComponent : FormComponentWithNestedComponents<SmartFolderSelectorProperties, SmartFolderSelectorClientProperties, SmartFolderReference>, IFormComponent, IFormItem<IFormComponentClientProperties>, IFormItem- Inheritance
-
objectFormComponent<SmartFolderSelectorProperties, SmartFolderSelectorClientProperties, SmartFolderReference>FormComponentWithNestedComponents<SmartFolderSelectorProperties, SmartFolderSelectorClientProperties, SmartFolderReference>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
formComponentCommandInvokerIFormComponentCommandInvokerformDataBinderIFormDataBindersmartFoldersProviderIInfoProvider<SmartFolderInfo>pageLinkGeneratorIPageLinkGeneratorcontentLanguageRetrieverIContentLanguageRetrieverlocalizationServiceILocalizationServicereusableFieldSchemaManagerIReusableFieldSchemaManagerserviceProviderIServiceProvidereventLogServiceIEventLogService
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.
[FormComponentCommand]
public Task<ICommandResponse<FilterFormChangeResult>> Change(FormSubmissionCommandArguments args, CancellationToken cancellationToken = default)Parameters
argsFormSubmissionCommandArgumentscancellationTokenCancellationToken
Returns
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.
[FormComponentCommand]
public Task<ICommandResponse<FilterFormChangeResult>> ChangeCreateSmartFolderForm(FormSubmissionCommandArguments args, CancellationToken cancellationToken = default)Parameters
argsFormSubmissionCommandArgumentscancellationTokenCancellationToken
Returns
ConfigureClientProperties(SmartFolderSelectorClientProperties)
Configures the form component client properties.
protected override Task ConfigureClientProperties(SmartFolderSelectorClientProperties clientProperties)Parameters
clientPropertiesSmartFolderSelectorClientPropertiesThe 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.
[FormComponentCommand]
public Task<ICommandResponse<CreateSmartFolderResult>> CreateSmartFolder(CreateSmartFolderArguments args, CancellationToken cancellationToken)Parameters
argsCreateSmartFolderArgumentscancellationTokenCancellationToken
Returns
CreateSmartFolderConfirmFilter(CreateSmartFolderConfirmFilterArguments, CancellationToken)
Routes the command to the CreateSmartFolderConfirmFilter(CreateSmartFolderConfirmFilterArguments, CancellationToken, int?, bool) method.
[FormComponentCommand]
public Task<ICommandResponse<CreateSmartFolderConfirmFilterResult>> CreateSmartFolderConfirmFilter(CreateSmartFolderConfirmFilterArguments args, CancellationToken cancellationToken)Parameters
argsCreateSmartFolderConfirmFilterArgumentscancellationTokenCancellationToken
Returns
GetFolder(GetSmartFolderRequest, CancellationToken)
Retrieves smart folder.
[FormComponentCommand]
public Task<ICommandResponse<GetSmartFolderResult>> GetFolder(GetSmartFolderRequest args, CancellationToken cancellationToken)Parameters
argsGetSmartFolderRequestcancellationTokenCancellationToken
Returns
GetFolders(GetSmartFoldersRequest, CancellationToken)
Retrieves all valid smart folders.
[FormComponentCommand]
public Task<ICommandResponse<GetSmartFoldersResult>> GetFolders(GetSmartFoldersRequest args, CancellationToken cancellationToken)Parameters
argsGetSmartFoldersRequestcancellationTokenCancellationToken
Returns
GetFormItemsForCreateSmartFolder(CancellationToken)
Routes the command to the Kentico.Xperience.Admin.Base.ISmartFolderCommandManager.GetFormItemsForCreateDeliverableSmartFolder(System.Threading.CancellationToken) method.
[FormComponentCommand]
public Task<ICommandResponse<GetFormItemsForCreateSmartFolderResult>> GetFormItemsForCreateSmartFolder(CancellationToken cancellationToken)Parameters
cancellationTokenCancellationToken
Returns
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.
[FormComponentCommand]
public Task<ICommandResponse<GetSmartFolderFilterDescriptionResult>> GetSmartFolderFilterDescription(GetSmartFolderFilterDescriptionArguments args, CancellationToken cancellationToken = default)Parameters
argsGetSmartFolderFilterDescriptionArgumentscancellationTokenCancellationToken
Returns
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.
[FormComponentCommand]
public Task<ICommandResponse<LoadDataResult>> LoadSmartFolderData(LoadSmartFolderDataCommandArguments args, CancellationToken cancellationToken = default)Parameters
argsLoadSmartFolderDataCommandArgumentscancellationTokenCancellationToken
Returns
- Task<ICommandResponse<LoadDataResult>>
LoadSmartFolderListingConfiguration(CancellationToken)
Routes the command to the Kentico.Xperience.Admin.Base.IContentListingCommandManager.LoadListingConfigurationForSmartFolderSelector(int, int, System.Threading.CancellationToken) method.
[FormComponentCommand]
public Task<ICommandResponse<LoadListingConfigurationCommandResult>> LoadSmartFolderListingConfiguration(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationToken