Class SubcaptionComponentBase<TProperties, TClientProperties>

Namespace

Kentico.Xperience.Admin.Base

Assembly

Kentico.Xperience.Admin.Base.dll

Configures which component to display as a subcaption in listing template.

public abstract class SubcaptionComponentBase<TProperties, TClientProperties> : ISubcaptionComponent where TProperties : class, new() where TClientProperties : class, new()

Type Parameters

TProperties

TClientProperties

Inheritance

object

SubcaptionComponentBase<TProperties, TClientProperties>

Implements

ISubcaptionComponent

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Properties

ComponentName

The name of the component to display as a subcaption.

public abstract string ComponentName { get; }

Property Value

string

ComponentProperties

Contains properties that can be used in ConfigureComponentClientProperties(TClientProperties) to configure client properties.

public TProperties ComponentProperties { get; set; }

Property Value

TProperties

Methods

ConfigureComponentClientProperties(TClientProperties)

Configures the client properties of the component used as subcaption.

protected virtual Task ConfigureComponentClientProperties(TClientProperties componentClientProperties)

Parameters

componentClientProperties TClientProperties

The current instance of the component client properties.

Returns

Task

Remarks

Override this method in order to configure component client properties.

GetClientProperties()

Function providing client properties for the subcaption loader.

public Task<SubcaptionComponentClientProperties> GetClientProperties()

Returns

Task<SubcaptionComponentClientProperties>