Table of Contents

Class EmailSelectorProperties

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

Represents properties of the EmailSelectorComponent.

public class EmailSelectorProperties : FormComponentProperties, IFormComponentProperties
Inheritance
object
EmailSelectorProperties
Implements
Inherited Members
Extension Methods

Constructors

EmailSelectorProperties() 

public EmailSelectorProperties()

Properties

AllowedEmailPurpose

Restricts the selection on the specified email purpose.

[DropDownComponent(Label = "{$digitalmarketing.emails.edit.purpose$}", DataProviderType = typeof(EmailConfigurationPurposeDropDownOptionsProvider), TooltipAsHtml = true, Tooltip = "{$digitalmarketing.emails.purpose.tooltip$}<ul><li>{$digitalmarketing.emails.purpose.tooltip.regular$}</li><li>{$digitalmarketing.emails.purpose.tooltip.autoresponder$}</li><li>{$digitalmarketing.emails.purpose.tooltip.confirmation$}</li></ul>", Order = 2)]
public string AllowedEmailPurpose { get; set; }

Property Value

string

Remarks

Note that this property is mutually exclusive with AllowedEmailPurposes.

AllowedEmailPurposes

Restricts the selection to a set of allowed email purposes.

public string[] AllowedEmailPurposes { get; set; }

Property Value

string[]

Remarks

Note that this property is mutually exclusive with AllowedEmailPurpose.

ForPreview

Indicates whether also unpublished versions of emails should be selectable.

[CheckBoxComponent(Label = "{$digitalmarketing.forms.emailselector.forpreview.label$}", Tooltip = "{$digitalmarketing.forms.emailselector.forpreview.tooltip$}", Order = 3)]
public bool ForPreview { get; set; }

Property Value

bool

Remarks

  • If true, the selector will also allow selection of unpublished emails.
  • Otherwise, only published emails will be selectable.
  • Default value is false.

MaximumEmails

Maximum amount of emails in the selector.

[NumberInputComponent(Label = "{$digitalmarketing.forms.emailselector.maximumemails.label$}", Tooltip = "{$digitalmarketing.forms.emailselector.maximumemails.tooltip$}", TooltipAsHtml = true)]
public int MaximumEmails { get; set; }

Property Value

int

Remarks

Following values can be used to limit the maximum number of emails: 0 - unlimited 1 - single email selection n - n-emails selection

Sortable

Allows sorting of selected emails.

[CheckBoxComponent(Label = "{$digitalmarketing.forms.emailselector.sortable.label$}", Tooltip = "{$digitalmarketing.forms.emailselector.sortable.tooltip$}")]
public bool Sortable { get; set; }

Property Value

bool