Class CampaignEdit

Namespace

Kentico.Xperience.Admin.DigitalMarketing.UIPages

Assembly

Kentico.Xperience.Admin.DigitalMarketing.dll

Edit tab of the campaign's edit page.

public sealed class CampaignEdit : InfoEditPage<CampaignInfo>, IPage

Inheritance

object

Page<EditTemplateClientProperties>

EditPageBase

InfoEditPageBase<CampaignInfo>

InfoEditPage<CampaignInfo>

CampaignEdit

Implements

IPage

Inherited Members

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

CampaignEdit(IFormComponentMapper, IFormDataBinder)

Initializes a new instance of the CampaignEdit class.

public CampaignEdit(IFormComponentMapper formComponentMapper, IFormDataBinder formDataBinder)

Parameters

formComponentMapper IFormComponentMapper

formDataBinder IFormDataBinder

Properties

ObjectId

ID of the campaign.

[PageParameter(typeof(IntPageModelBinder))]
public override int ObjectId { get; set; }

Property Value

int

Methods

ConfigurePage()

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

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.

SetFormData(CampaignInfo, IFormFieldValueProvider)

Sets the infoObject.

protected override Task SetFormData(CampaignInfo infoObject, IFormFieldValueProvider fieldValueProvider)

Parameters

infoObject CampaignInfo

Info object to be set.

fieldValueProvider IFormFieldValueProvider

Provider of form field values.

Returns

Task