Class AssetSelectorComponent

Namespace

Kentico.Xperience.Admin.Base.Forms

Assembly

Kentico.Xperience.Admin.Base.dll

Represents assets selector form component.

[ComponentAttribute(typeof(AssetSelectorComponentAttribute))]
public sealed class AssetSelectorComponent : FormComponent<AssetSelectorProperties, AssetSelectorClientProperties, IEnumerable<AssetRelatedItem>>, IFormComponent, IFormItem<IFormComponentClientProperties>, IFormItem

Inheritance

object

FormComponent<AssetSelectorProperties, AssetSelectorClientProperties, IEnumerable<AssetRelatedItem>>

AssetSelectorComponent

Implements

IFormComponent

IFormItem<IFormComponentClientProperties>

IFormItem

Inherited Members

FormComponent<AssetSelectorProperties, AssetSelectorClientProperties, IEnumerable<AssetRelatedItem>>.ClientComponentName

FormComponent<AssetSelectorProperties, AssetSelectorClientProperties, IEnumerable<AssetRelatedItem>>.Properties

FormComponent<AssetSelectorProperties, AssetSelectorClientProperties, IEnumerable<AssetRelatedItem>>.FormContext

FormComponent<AssetSelectorProperties, AssetSelectorClientProperties, IEnumerable<AssetRelatedItem>>.Name

FormComponent<AssetSelectorProperties, AssetSelectorClientProperties, IEnumerable<AssetRelatedItem>>.Guid

FormComponent<AssetSelectorProperties, AssetSelectorClientProperties, IEnumerable<AssetRelatedItem>>.Required

FormComponent<AssetSelectorProperties, AssetSelectorClientProperties, IEnumerable<AssetRelatedItem>>.HasDependencies

FormComponent<AssetSelectorProperties, AssetSelectorClientProperties, IEnumerable<AssetRelatedItem>>.ValidationRules

FormComponent<AssetSelectorProperties, AssetSelectorClientProperties, IEnumerable<AssetRelatedItem>>.VisibilityConditions

FormComponent<AssetSelectorProperties, AssetSelectorClientProperties, IEnumerable<AssetRelatedItem>>.AdditionalActions

FormComponent<AssetSelectorProperties, AssetSelectorClientProperties, IEnumerable<AssetRelatedItem>>.AddValidationRule(IValidationRule)

FormComponent<AssetSelectorProperties, AssetSelectorClientProperties, IEnumerable<AssetRelatedItem>>.AddAdditionalAction(IAdditionalAction)

FormComponent<AssetSelectorProperties, AssetSelectorClientProperties, IEnumerable<AssetRelatedItem>>.AddVisibilityCondition(IVisibilityCondition)

FormComponent<AssetSelectorProperties, AssetSelectorClientProperties, IEnumerable<AssetRelatedItem>>.GetValue()

FormComponent<AssetSelectorProperties, AssetSelectorClientProperties, IEnumerable<AssetRelatedItem>>.SetValue(IEnumerable<AssetRelatedItem>)

FormComponent<AssetSelectorProperties, AssetSelectorClientProperties, IEnumerable<AssetRelatedItem>>.GetClientProperties()

FormComponent<AssetSelectorProperties, AssetSelectorClientProperties, IEnumerable<AssetRelatedItem>>.BindContext(IFormContext)

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

FormItemExtensions.IsValid(IFormItem)

FormItemExtensions.IsVisible(IFormItem)

Constructors

AssetSelectorComponent(ILocalizationService, ISettingsService, IAssetItemMapper)

Initializes a new instance of AssetSelectorComponent.

public AssetSelectorComponent(ILocalizationService localizationService, ISettingsService settingsService, IAssetItemMapper assetItemMapper)

Parameters

localizationService ILocalizationService

Localization service.

settingsService ISettingsService

Settings service.

assetItemMapper IAssetItemMapper

Asset item mapper.

Fields

IDENTIFIER

Represents the AssetSelectorComponent identifier.

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

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(AssetSelectorClientProperties)

Configures the form component client properties.

protected override Task ConfigureClientProperties(AssetSelectorClientProperties clientProperties)

Parameters

clientProperties AssetSelectorClientProperties

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.

LoadAssetFolders(LoadAssetFoldersCommandArguments)

Loads assets folders.

public Task<ICommandResponse<LoadAssetFoldersResult>> LoadAssetFolders(LoadAssetFoldersCommandArguments args)

Parameters

args LoadAssetFoldersCommandArguments

Returns

Task<ICommandResponse<LoadAssetFoldersResult>>

LoadAssetItems(LoadAssetItemsCommandArguments)

Loads assets panel items.

public Task<ICommandResponse<LoadAssetItemsResult>> LoadAssetItems(LoadAssetItemsCommandArguments args)

Parameters

args LoadAssetItemsCommandArguments

Returns

Task<ICommandResponse<LoadAssetItemsResult>>

LoadAssetLibraries()

Loads assets libraries.

public Task<ICommandResponse<LoadAssetLibrariesResult>> LoadAssetLibraries()

Returns

Task<ICommandResponse<LoadAssetLibrariesResult>>

UploadAssets(UploadAssetsCommandArguments)

Upload files to media library.

public Task<ICommandResponse<UploadAssetsCommandResult>> UploadAssets(UploadAssetsCommandArguments args)

Parameters

args UploadAssetsCommandArguments

Upload command arguments.

Returns

Task<ICommandResponse<UploadAssetsCommandResult>>