Class RegisterEmailSectionAttribute

Namespace

Kentico.EmailBuilder.Web.Mvc

Assembly

Kentico.Content.Web.Mvc.dll

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

public sealed class RegisterEmailSectionAttribute : RegisterComponentAttribute, IPreInitAttribute

Inheritance

object

Attribute

RegisterComponentAttribute

RegisterEmailSectionAttribute

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

RegisterEmailSectionAttribute(string, string, Type)

Registers an email builder section.

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

Parameters

identifier string

Unique identifier of the section definition.

name string

Name of the registered section.

componentType Type

Type of section component being registered.

Remarks

Make sure to provide unique identifier for the section 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_SectionName', e.g. 'Kentico_Content_SingleColumn'.

Properties

PropertiesType

Type of the registered email section properties model.

public Type PropertiesType { get; set; }

Property Value

Type

Remarks

The type needs to implement the IEmailSectionProperties interface.

Methods

PreInit()

Registers the section definition during application pre-initialization.

public override void PreInit()