Table of Contents

Class ContentFolderSelectorComponent

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

The form component for selecting content folders.

[ComponentAttribute(typeof(ContentFolderSelectorComponentAttribute))]
public sealed class ContentFolderSelectorComponent : FormComponent<ContentFolderSelectorProperties, ContentFolderSelectorClientProperties, int>, IFormComponent, IFormItem<IFormComponentClientProperties>, IFormItem
Inheritance
object
ContentFolderSelectorComponent
Implements
Inherited Members
Extension Methods

Constructors

ContentFolderSelectorComponent(IInfoProvider<ContentFolderInfo>, ILocalizationService, IServiceProvider, IInfoProvider<WorkspaceInfo>)

Initializes a new instance of the ContentFolderSelectorComponent class.

public ContentFolderSelectorComponent(IInfoProvider<ContentFolderInfo> contentFolderProvider, ILocalizationService localization, IServiceProvider serviceProvider, IInfoProvider<WorkspaceInfo> workspaceInfoProvider)

Parameters

contentFolderProvider IInfoProvider<ContentFolderInfo>
localization ILocalizationService
serviceProvider IServiceProvider
workspaceInfoProvider IInfoProvider<WorkspaceInfo>

Fields

IDENTIFIER

Represents the ContentFolderSelectorComponent identifier.

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

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

BindContext(IFormContext)

Binds context to the form component.

public override Task BindContext(IFormContext context)

Parameters

context IFormContext

Context to be used.

Returns

Task

Remarks

This method is called later than ConfigureComponent() method.

ConfigureClientProperties(ContentFolderSelectorClientProperties)

Configures the form component client properties.

protected override Task ConfigureClientProperties(ContentFolderSelectorClientProperties clientProperties)

Parameters

clientProperties ContentFolderSelectorClientProperties

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.

GetFolder(GetFolderArguments, CancellationToken)

Routes the command to the GetFolder(GetFolderArguments, CancellationToken) method.

[FormComponentCommand]
public Task<ICommandResponse<Folder>> GetFolder(GetFolderArguments args, CancellationToken cancellationToken)

Parameters

args GetFolderArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<Folder>>

GetFolderPath(GetFolderArguments, CancellationToken)

Routes the command to the GetFolderPath(GetFolderArguments, CancellationToken) method.

[FormComponentCommand]
public Task<ICommandResponse<ICollection<Folder>>> GetFolderPath(GetFolderArguments args, CancellationToken cancellationToken)

Parameters

args GetFolderArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<ICollection<Folder>>>