Class WebsiteChannelSettings

Namespace

Kentico.Xperience.Admin.Websites.UIPages

Assembly

Kentico.Xperience.Admin.Websites.dll

Website channel settings page.

[UINavigation(false)]
public sealed class WebsiteChannelSettings : ModelEditPage<WebsiteChannelSettingsModel>, IPage

Inheritance

object

Page<EditTemplateClientProperties>

EditPageBase

ModelEditPage<WebsiteChannelSettingsModel>

WebsiteChannelSettings

Implements

IPage

Inherited Members

ModelEditPage<WebsiteChannelSettingsModel>.Change(FormChangeCommandArguments)

ModelEditPage<WebsiteChannelSettingsModel>.ConfigureTemplateProperties(EditTemplateClientProperties)

ModelEditPage<WebsiteChannelSettingsModel>.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

WebsiteChannelSettings(IFormItemCollectionProvider, IFormDataBinder, ITreePathValidator, IInfoProvider<WebsiteChannelInfo>, IInfoProvider<WebsiteCaptchaSettingsInfo>)

Initializes a new instance of WebsiteChannelSettings.

public WebsiteChannelSettings(IFormItemCollectionProvider formItemCollectionProvider, IFormDataBinder formDataBinder, ITreePathValidator treePathValidator, IInfoProvider<WebsiteChannelInfo> websiteChannelProvider, IInfoProvider<WebsiteCaptchaSettingsInfo> websiteCaptchaSettingInfoProvider)

Parameters

formItemCollectionProvider IFormItemCollectionProvider

formDataBinder IFormDataBinder

treePathValidator ITreePathValidator

websiteChannelProvider IInfoProvider<WebsiteChannelInfo>

websiteCaptchaSettingInfoProvider IInfoProvider<WebsiteCaptchaSettingsInfo>

Properties

ChannelId

Channel id.

[PageParameter(typeof(WebsiteChannelModelBinder))]
public int ChannelId { get; set; }

Property Value

int

Model

Gets edited model that represents the form.

protected override WebsiteChannelSettingsModel Model { get; }

Property Value

WebsiteChannelSettingsModel

RefetchAll

Indicates whether to refetch all templates on edit.

protected override bool RefetchAll { get; }

Property Value

bool

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

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

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

Parameters

model WebsiteChannelSettingsModel

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.