Class AdditionalAction<TProperties, TClientProperties>

Namespace

Kentico.Xperience.Admin.Base

Assembly

Kentico.Xperience.Admin.Base.dll

Additional action - a component that is attached to some form component and may provide its own component commands.

public abstract class AdditionalAction<TProperties, TClientProperties> : IAdditionalAction where TProperties : AdditionalActionProperties, new() where TClientProperties : AdditionalActionClientProperties, new()

Type Parameters

TProperties

TClientProperties

Inheritance

object

AdditionalAction<TProperties, TClientProperties>

Implements

IAdditionalAction

Derived

AdditionalActionWithNestedForm<TProperties, TClientProperties, TModel>

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Properties

ClientComponentName

Name of the front-end component of the additional action.

public abstract string ClientComponentName { get; }

Property Value

string

Remarks

If set to null, the additional action will not be rendered on the client side.

FormContext

Form context of the component the additional action belongs to.

protected IFormContext FormContext { get; }

Property Value

IFormContext

Identifier

Identifier of an additional action. Has to be unique within the form component it's attached to.

public string Identifier { get; set; }

Property Value

string

Properties

Contains values of configurable properties for the additional action.

public TProperties Properties { get; }

Property Value

TProperties

Methods

ConfigureClientProperties(TClientProperties)

Allows client properties configuration.

protected virtual Task ConfigureClientProperties(TClientProperties clientProperties)

Parameters

clientProperties TClientProperties

Current instance of client properties.

Returns

Task

Remarks

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