Class FormGeneralTab

Namespace

Kentico.Xperience.Admin.DigitalMarketing.UIPages

Assembly

Kentico.Xperience.Admin.DigitalMarketing.dll

General tab of the form edit page.

[UIPageLocation(PageLocationEnum.SidePanel)]
public sealed class FormGeneralTab : ModelEditPage<FormGeneralPropertiesModel>, IPage

Inheritance

object

Page<EditTemplateClientProperties>

EditPageBase

ModelEditPage<FormGeneralPropertiesModel>

FormGeneralTab

Implements

IPage

Inherited Members

ModelEditPage<FormGeneralPropertiesModel>.Change(FormChangeCommandArguments)

ModelEditPage<FormGeneralPropertiesModel>.ConfigureTemplateProperties(EditTemplateClientProperties)

ModelEditPage<FormGeneralPropertiesModel>.ValidatePage()

EditPageBase.PageConfiguration

EditPageBase.ComponentCommand(FormComponentCommandModel, CancellationToken)

EditPageBase.Submit(FormSubmissionCommandArguments)

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

FormGeneralTab(IFormItemCollectionProvider, IFormDataBinder)

Initializes an instance of the FormGeneralTab class.

public FormGeneralTab(IFormItemCollectionProvider formItemCollectionProvider, IFormDataBinder formDataBinder)

Parameters

formItemCollectionProvider IFormItemCollectionProvider

formDataBinder IFormDataBinder

Properties

Model

Gets edited model that represents the form.

protected override FormGeneralPropertiesModel Model { get; }

Property Value

FormGeneralPropertiesModel

ObjectId

ID of the form.

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

Property Value

int

Methods

ConfigurePage()

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

public override Task ConfigurePage()

Returns

Task

GetObjectDisplayName(FormGeneralPropertiesModel)

Gets object display name to be used in breadcrumbs, navigation items etc. if they have to be updated after the Submit(FormSubmissionCommandArguments) command success.

protected override Task<string> GetObjectDisplayName(FormGeneralPropertiesModel model)

Parameters

model FormGeneralPropertiesModel

Currently processed model.

Returns

Task<string>

The object display name to be used in breadcrumbs, navigation items etc., or null, should the display name not be changed after the Submit(FormSubmissionCommandArguments) command success.

See Also

ObjectDisplayName

ProcessFormData(FormGeneralPropertiesModel, ICollection<IFormItem>)

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

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

Parameters

model FormGeneralPropertiesModel

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.