Table of Contents

Class RegisterAdditionalActionAttribute

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

Registers an additional action for form components.

[AttributeUsage(AttributeTargets.Assembly, AllowMultiple = true)]
public sealed class RegisterAdditionalActionAttribute : Attribute
Inheritance
object
Attribute
RegisterAdditionalActionAttribute
Extension Methods

Remarks

Use attribute to register additional action to the system. It is not mandatory to register additional action. Form component implementation can instantiate specific action itself and call AddAdditionalAction(IAdditionalAction) method. Registered additional action is available for fields with specific field data types.

Constructors

RegisterAdditionalActionAttribute(string, Type, string, string, string[], string, string[])

Initializes a new instance of the RegisterAdditionalActionAttribute class.

public RegisterAdditionalActionAttribute(string systemIdentifier, Type additionalActionType, string name, string description = null, string[] targetFieldDataTypes = null, string category = "default", string[] formComponentLimitations = null)

Parameters

systemIdentifier string

Unique system identifier of the additional action.

additionalActionType Type

Type implementing the AdditionalAction<TProperties, TClientProperties>.

name string

Name of the additional action.

description string

Description of the additional action, null by default.

targetFieldDataTypes string[]

Target FieldDataType for which the additional action will be applied. If null, the additional action is registered to all data types.

category string

Additional action category.

formComponentLimitations string[]

Specifies form component identifiers for which the additional action will be available exclusively. Default value is null, which means the additional action can be used with any form component without limitations.

Properties

Category

Additional action category.

public string Category { get; }

Property Value

string

Description

Description of the additional action, null by default.

public string Description { get; }

Property Value

string

FormComponentLimitations

Some additional actions may only be compatible with a limited set of form components. This property contains form component identifiers for which the additional action will be available exclusively. Pass null if the additional action can be used with any form component without limitations.

public string[] FormComponentLimitations { get; }

Property Value

string[]

MarkedType

Type implementing the AdditionalAction<TProperties, TClientProperties>.

public Type MarkedType { get; }

Property Value

Type

Name

Name of the additional action.

public string Name { get; }

Property Value

string

SystemIdentifier

Unique system identifier of the additional action.

public string SystemIdentifier { get; }

Property Value

string

TargetFieldDataTypes

Target field data types for which the additional action will be available. Pass FieldDataType.All to provide the additional action to all fields no matter what type they are.

public string[] TargetFieldDataTypes { get; }

Property Value

string[]