Table of Contents

Class EmailPropertiesTabPageBase

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

Properties tab of an email page.

public abstract class EmailPropertiesTabPageBase : ModelEditPage<EmailConfigurationPropertiesModel>, IPage
Inheritance
object
EmailPropertiesTabPageBase
Implements
Derived
Inherited Members
Extension Methods

Properties

ChannelApplicationIdentifier

Application identifier.

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

Property Value

EmailChannelApplicationUrlIdentifier

ContentLanguageIdentifier

Content language identifier.

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

Property Value

ContentLanguageUrlIdentifier

EmailConfigurationID

Email configuration identifier.

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

Property Value

int

Model

Gets edited model that represents the form.

protected override EmailConfigurationPropertiesModel Model { get; }

Property Value

EmailConfigurationPropertiesModel

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(EmailConfigurationPropertiesModel, ICollection<IFormItem>)

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

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

Parameters

model EmailConfigurationPropertiesModel

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.

[PageCommand(Permission = "Update")]
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