Table of Contents

Class SaveAsTemplate

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

Save as template page.

[UINavigation(false)]
[UIBreadcrumbs(false)]
[UIPageLocation(PageLocationEnum.Dialog)]
[UIEvaluatePermission("View")]
public sealed class SaveAsTemplate : CreatePage<PageTemplateConfigurationInfo, PageBuilderTab>, IPage
Inheritance
object
SaveAsTemplate
Implements
Inherited Members
Extension Methods

Constructors

SaveAsTemplate(IFormComponentMapper, IFormDataBinder, IPageLinkGenerator, IPageBuilderConfigurationSourceLoader)

Initializes a new instance of the SaveAsTemplate class.

public SaveAsTemplate(IFormComponentMapper formComponentMapper, IFormDataBinder formDataBinder, IPageLinkGenerator pageLinkGenerator, IPageBuilderConfigurationSourceLoader pageBuilderConfigurationSourceLoader)

Parameters

formComponentMapper IFormComponentMapper
formDataBinder IFormDataBinder
pageLinkGenerator IPageLinkGenerator
pageBuilderConfigurationSourceLoader IPageBuilderConfigurationSourceLoader

Properties

ApplicationIdentifier

Application identifier.

[PageParameter(typeof(WebPagesApplicationModelBinder), typeof(WebPagesApplication))]
public WebPagesApplicationUrlIdentifier ApplicationIdentifier { get; set; }

Property Value

WebPagesApplicationUrlIdentifier

WebPageIdentifier

Identifier of the current web page.

[PageParameter(typeof(WebPageUrlIdentifierPageModelBinder), typeof(WebPageLayout))]
public WebPageUrlIdentifier WebPageIdentifier { get; set; }

Property Value

WebPageUrlIdentifier

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 UI page.

public override Task ConfigurePage()

Returns

Task

FinalizeInfoObject(PageTemplateConfigurationInfo, IFormFieldValueProvider, CancellationToken)

Allows to modify values of infoObject before validation and saving.

protected override Task FinalizeInfoObject(PageTemplateConfigurationInfo infoObject, IFormFieldValueProvider fieldValueProvider, CancellationToken cancellationToken)

Parameters

infoObject PageTemplateConfigurationInfo

Info object to be set.

fieldValueProvider IFormFieldValueProvider

Provider of form field values.

cancellationToken CancellationToken

The cancellation instruction.

Returns

Task

GetSubmitSuccessResponse(PageTemplateConfigurationInfo, ICollection<IFormItem>)

Response that has to be returned after successful form submission.

protected override Task<ICommandResponse> GetSubmitSuccessResponse(PageTemplateConfigurationInfo savedInfoObject, ICollection<IFormItem> items)

Parameters

savedInfoObject PageTemplateConfigurationInfo

Object info after persisting.

items ICollection<IFormItem>

Collection with updated form items.

Returns

Task<ICommandResponse>

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