Class WebPageSecurity

Namespace

Kentico.Xperience.Admin.Websites.UIPages

Assembly

Kentico.Xperience.Admin.Websites.dll

Web page security properties page.

public sealed class WebPageSecurity : WebPageModelEditPageBase<WebPageSecurityModel>, IPage

Inheritance

object

Page<EditTemplateClientProperties>

EditPageBase

ModelEditPage<WebPageSecurityModel>

WebPageModelEditPageBase<WebPageSecurityModel>

WebPageSecurity

Implements

IPage

Inherited Members

WebPageModelEditPageBase<WebPageSecurityModel>.ConfigureTemplateProperties(EditTemplateClientProperties)

WebPageModelEditPageBase<WebPageSecurityModel>.ApplicationIdentifier

WebPageModelEditPageBase<WebPageSecurityModel>.WebPageIdentifier

ModelEditPage<WebPageSecurityModel>.Change(FormChangeCommandArguments)

ModelEditPage<WebPageSecurityModel>.ValidatePage()

EditPageBase.ComponentCommand(FormComponentCommandModel, CancellationToken)

EditPageBase.PageConfiguration

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

WebPageSecurity(IFormDataBinder, IWebPageManagerFactory, IAuthenticatedUserAccessor, IServiceProvider)

Initializes a new instance of the WebPageSecurity class.

public WebPageSecurity(IFormDataBinder formDataBinder, IWebPageManagerFactory webPageManagerFactory, IAuthenticatedUserAccessor authenticatedUserAccessor, IServiceProvider serviceProvider)

Parameters

formDataBinder IFormDataBinder

webPageManagerFactory IWebPageManagerFactory

authenticatedUserAccessor IAuthenticatedUserAccessor

serviceProvider IServiceProvider

Properties

Model

Gets edited model that represents the form.

protected override WebPageSecurityModel Model { get; }

Property Value

WebPageSecurityModel

SuccessMessageKey

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

protected override string SuccessMessageKey { get; }

Property Value

string

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

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

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

Parameters

model WebPageSecurityModel

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

SubmitInternal(FormSubmissionCommandArguments, ICollection<IFormItem>, IFormFieldValueProvider)