Class CampaignCreate

Namespace

Kentico.Xperience.Admin.DigitalMarketing.UIPages

Assembly

Kentico.Xperience.Admin.DigitalMarketing.dll

Campaign creation page.

public sealed class CampaignCreate : CreatePage<CampaignInfo, CampaignAssets>, IPage

Inheritance

object

Page<EditTemplateClientProperties>

EditPageBase

InfoEditPageBase<CampaignInfo>

CreatePage<CampaignInfo, CampaignAssets>

CampaignCreate

Implements

IPage

Inherited Members

CreatePage<CampaignInfo, CampaignAssets>.ConfigurePage()

CreatePage<CampaignInfo, CampaignAssets>.ConfigureTemplateProperties(EditTemplateClientProperties)

CreatePage<CampaignInfo, CampaignAssets>.Change(FormChangeCommandArguments)

CreatePage<CampaignInfo, CampaignAssets>.Submit(FormSubmissionCommandArguments)

InfoEditPageBase<CampaignInfo>.ConfigureTemplateProperties(EditTemplateClientProperties)

InfoEditPageBase<CampaignInfo>.ValidatePage()

InfoEditPageBase<CampaignInfo>.RegisterMacroField(MacroField)

EditPageBase.ComponentCommand(FormComponentCommandModel, CancellationToken)

EditPageBase.Change(FormChangeCommandArguments)

EditPageBase.Submit(FormSubmissionCommandArguments)

EditPageBase.PageConfiguration

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

CampaignCreate(IFormComponentMapper, IFormDataBinder, IPageLinkGenerator)

Initializes an instance of the CampaignCreate class.

public CampaignCreate(IFormComponentMapper formComponentMapper, IFormDataBinder formDataBinder, IPageLinkGenerator pageLinkGenerator)

Parameters

formComponentMapper IFormComponentMapper

formDataBinder IFormDataBinder

pageLinkGenerator IPageLinkGenerator

Methods

Cancel()

Cancel the creation of a new campaign and redirects to the listing.

[PageCommand]
public Task<INavigateResponse> Cancel()

Returns

Task<INavigateResponse>

ConfigurePage()

Set up page's configuration. Configures UI page.

public override Task ConfigurePage()

Returns

Task

ExtendFormItemsBasedOnFormData(ICollection<IFormItem>, Dictionary<string, JsonElement>)

Allows users to modify form items and form data before binding context and values.

protected override Task<ICollection<IFormItem>> ExtendFormItemsBasedOnFormData(ICollection<IFormItem> items, Dictionary<string, JsonElement> formData)

Parameters

items ICollection<IFormItem>

Form items.

formData Dictionary<string, JsonElement>

Form data.

Returns

Task<ICollection<IFormItem>>

Updated collection of form items.

FinalizeInfoObject(CampaignInfo, IFormFieldValueProvider, CancellationToken)

Allows to modify values of infoObject before validation and saving.

protected override Task FinalizeInfoObject(CampaignInfo infoObject, IFormFieldValueProvider fieldValueProvider, CancellationToken cancellationToken)

Parameters

infoObject CampaignInfo

Info object to be set.

fieldValueProvider IFormFieldValueProvider

Provider of form field values.

cancellationToken CancellationToken

The cancellation instruction.

Returns

Task

GetFormItems()

Prepares form items for editing object of the specified ObjectType.

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

Returns

Task<ICollection<IFormItem>>

Returns the collection of form items.