Table of Contents

Class EmailPlainTextTab

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

Plain text tab of the email's edit page.

[UIPageLocation(PageLocationEnum.SidePanel)]
[UIBreadcrumbs(false)]
public sealed class EmailPlainTextTab : ModelEditPage<EmailPlainTextModel>, IPage
Inheritance
object
EmailPlainTextTab
Implements
Inherited Members
Extension Methods

Constructors

EmailPlainTextTab(IFormItemCollectionProvider, IFormDataBinder, IAuthenticatedUserAccessor, IEmailConfigurationManagerFactory, IContentItemUIDataRetriever, IEmailConfigurationAdminModelRetriever, IEmailConfigurationWorkflowStepRoleArbiter)

Initializes a new instance of the EmailPlainTextTab class.

public EmailPlainTextTab(IFormItemCollectionProvider formItemCollectionProvider, IFormDataBinder formDataBinder, IAuthenticatedUserAccessor authenticatedUserAccessor, IEmailConfigurationManagerFactory emailConfigurationManagerFactory, IContentItemUIDataRetriever contentItemUIDataRetriever, IEmailConfigurationAdminModelRetriever emailConfigurationAdminModelRetriever, IEmailConfigurationWorkflowStepRoleArbiter workflowStepRoleArbiter)

Parameters

formItemCollectionProvider IFormItemCollectionProvider
formDataBinder IFormDataBinder
authenticatedUserAccessor IAuthenticatedUserAccessor
emailConfigurationManagerFactory IEmailConfigurationManagerFactory
contentItemUIDataRetriever IContentItemUIDataRetriever
emailConfigurationAdminModelRetriever IEmailConfigurationAdminModelRetriever
workflowStepRoleArbiter IEmailConfigurationWorkflowStepRoleArbiter

Properties

ApplicationIdentifier

Application identifier.

[PageParameter(typeof(EmailChannelsApplicationModelBinder), typeof(EmailChannelApplication))]
public EmailChannelApplicationUrlIdentifier ApplicationIdentifier { get; set; }

Property Value

EmailChannelApplicationUrlIdentifier

ContentLanguageIdentifier

Content language identifier.

[PageParameter(typeof(ContentLanguageModelBinder), typeof(EmailChannelContentLanguage))]
public ContentLanguageUrlIdentifier ContentLanguageIdentifier { get; set; }

Property Value

ContentLanguageUrlIdentifier

EmailConfigurationID

ID of the email configuration.

[PageParameter(typeof(IntPageModelBinder), typeof(EmailEditLayout))]
public int EmailConfigurationID { get; set; }

Property Value

int

Model

Gets edited model that represents the form.

protected override EmailPlainTextModel Model { get; }

Property Value

EmailPlainTextModel

Methods

ConfigurePage()

Set up page's configuration. Configures the submit action.

public override Task ConfigurePage()

Returns

Task

GetFormItems()

Examines properties of Model and returns corresponding IFormItems.

protected override Task<ICollection<IFormItem>> GetFormItems()

Returns

Task<ICollection<IFormItem>>

Remarks

Override the method in case when additional set-up of form components is required.

ProcessFormData(EmailPlainTextModel, ICollection<IFormItem>)

Stores the model and creates a response for the Submit(FormSubmissionCommandArguments) command.

protected override Task<ICommandResponse> ProcessFormData(EmailPlainTextModel model, ICollection<IFormItem> formItems)

Parameters

model EmailPlainTextModel

Model to be stored.

formItems ICollection<IFormItem>

Form items with bound component values.

Returns

Task<ICommandResponse>

The response to be used for the Submit(FormSubmissionCommandArguments) command.

Submit(FormSubmissionCommandArguments)

Handles the form submit command.

public override Task<ICommandResponse> Submit(FormSubmissionCommandArguments args)

Parameters

args FormSubmissionCommandArguments

Form submission arguments.

Returns

Task<ICommandResponse>

Returns the form submission result.

Remarks

The default implementation calls the SubmitInternal(FormSubmissionCommandArguments, ICollection<IFormItem>, IFormFieldValueProvider) method.

See Also