Table of Contents

Class WebPageInformation

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

Page information properties page.

public sealed class WebPageInformation : WebPageModelEditPageBase<WebPageInformationModel>, IPage
Inheritance
object
WebPageInformation
Implements
Inherited Members
Extension Methods

Constructors

WebPageInformation(IFormDataBinder, IAuthenticatedUserAccessor, IWebPageManagerFactory, ITreePathValidator, IContentLanguageRetriever, IServiceProvider)

Initializes a new instance of the WebPageInformation class.

public WebPageInformation(IFormDataBinder formDataBinder, IAuthenticatedUserAccessor authenticatedUserAccessor, IWebPageManagerFactory webPageManagerFactory, ITreePathValidator treePathValidator, IContentLanguageRetriever contentLanguageRetriever, IServiceProvider serviceProvider)

Parameters

formDataBinder IFormDataBinder
authenticatedUserAccessor IAuthenticatedUserAccessor
webPageManagerFactory IWebPageManagerFactory
treePathValidator ITreePathValidator
contentLanguageRetriever IContentLanguageRetriever
serviceProvider IServiceProvider

Properties

Model

Gets edited model that represents the form.

protected override WebPageInformationModel Model { get; }

Property Value

WebPageInformationModel

SuccessMessageKey

Gets or sets the success message displayed after submitting the form.

protected override string SuccessMessageKey { get; }

Property Value

string

Methods

Change(FormChangeCommandArguments)

Handles the form change command. The command is invoked whenever visibility conditions of the form need to be reevaluated to re-render the form.

[PageCommand(Permission = "View")]
public override Task<ICommandResponse<FormChangeResult>> Change(FormChangeCommandArguments args)

Parameters

args FormChangeCommandArguments

Form change arguments.

Returns

Task<ICommandResponse<FormChangeResult>>

Returns the form change result.

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

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

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

Parameters

model WebPageInformationModel

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 = "View")]
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