Table of Contents

Interface IAdditionalAction

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

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

public interface IAdditionalAction
Extension Methods

Remarks

The system uses this interface to process additional actions. For defining custom additional actions, inherit the AdditionalAction<TProperties, TClientProperties> class.

Properties

Identifier

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

string Identifier { get; set; }

Property Value

string

Methods

BindContext(IFormContext)

Binds context to the additional action.

Task BindContext(IFormContext context)

Parameters

context IFormContext

Context to be used.

Returns

Task

GetClientProperties()

Returns additional action's client properties defined by additional action implementation.

Task<AdditionalActionClientProperties> GetClientProperties()

Returns

Task<AdditionalActionClientProperties>

GetProperties()

Returns additional action's configuration properties.

AdditionalActionProperties GetProperties()

Returns

AdditionalActionProperties

SetProperties(AdditionalActionProperties)

Sets the additional action configuration properties.

void SetProperties(AdditionalActionProperties properties)

Parameters

properties AdditionalActionProperties

See Also

AdditionalAction<TProperties, TClientProperties>