Class RegisterEmailWidgetAttribute

Namespace

Kentico.EmailBuilder.Web.Mvc

Assembly

Kentico.Content.Web.Mvc.dll

Registers a widget definition to be used within Email builder feature.

public sealed class RegisterEmailWidgetAttribute : RegisterComponentAttribute, IPreInitAttribute

Inheritance

object

Attribute

RegisterComponentAttribute

RegisterEmailWidgetAttribute

Implements

IPreInitAttribute

Inherited Members

RegisterComponentAttribute.MarkedType

RegisterComponentAttribute.Identifier

RegisterComponentAttribute.Name

RegisterComponentAttribute.Description

RegisterComponentAttribute.IconClass

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

RegisterEmailWidgetAttribute(string, string, Type)

Registers an email builder widget.

public RegisterEmailWidgetAttribute(string identifier, string name, Type componentType)

Parameters

identifier string

Unique identifier of the widget definition.

name string

Name of the registered widget.

componentType Type

Component type of the registered widget.

Remarks

Make sure to provide unique identifier for the widget definition from the start. This identifier is used within the email configuration and any further change can lead to incorrect configuration load. Consider specifying identifier in format 'CompanyName_ModuleName_WidgetName', e.g. 'Kentico_Content_ArticlesListWidget'.

Properties

PropertiesType

Type of the registered email widget properties model.

public Type PropertiesType { get; set; }

Property Value

Type

Remarks

The type needs to implement the IEmailWidgetProperties interface.

Methods

PreInit()

Registers the widget definition during application pre-initialization.

public override void PreInit()