Class ActionComponent<TProperties, TClientProperties>

Namespace

Kentico.Xperience.Admin.Base

Assembly

Kentico.Xperience.Admin.Base.dll

Represents a base class for a action component to be loaded.

public abstract class ActionComponent<TProperties, TClientProperties> : IActionComponent where TProperties : IActionComponentProperties where TClientProperties : IActionComponentClientProperties, new()

Type Parameters

TProperties

TClientProperties

Inheritance

object

ActionComponent<TProperties, TClientProperties>

Implements

IActionComponent

Derived

MassPublishComponent

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Properties

ClientComponentName

Name of the front-end type implementing the action component.

public abstract string ClientComponentName { get; }

Property Value

string

Properties

Gets the server component properties.

public TProperties Properties { get; init; }

Property Value

TProperties

Methods

ConfigureClientProperties(TClientProperties)

Configures the action component client properties.

protected virtual Task ConfigureClientProperties(TClientProperties clientProperties)

Parameters

clientProperties TClientProperties

The current instance of the action component client properties.

Returns

Task

Remarks

Override this method in order to configure action component client properties.

GetClientProperties()

Returns action component client properties defined by a component implementation.

public Task<IActionComponentClientProperties> GetClientProperties()

Returns

Task<IActionComponentClientProperties>