Class TagCreate

Namespace

Kentico.Xperience.Admin.Base.UIPages

Assembly

Kentico.Xperience.Admin.Base.dll

Page for creating the tag.

[UINavigation(false)]
[UIBreadcrumbs(false)]
public sealed class TagCreate : CreatePage<TagInfo, TagEdit>, IPage

Inheritance

object

Page<EditTemplateClientProperties>

EditPageBase

InfoEditPageBase<TagInfo>

CreatePage<TagInfo, TagEdit>

TagCreate

Implements

IPage

Inherited Members

CreatePage<TagInfo, TagEdit>.ConfigurePage()

CreatePage<TagInfo, TagEdit>.ConfigureTemplateProperties(EditTemplateClientProperties)

CreatePage<TagInfo, TagEdit>.Change(FormChangeCommandArguments)

CreatePage<TagInfo, TagEdit>.Submit(FormSubmissionCommandArguments)

InfoEditPageBase<TagInfo>.ConfigureTemplateProperties(EditTemplateClientProperties)

InfoEditPageBase<TagInfo>.RegisterMacroField(MacroField)

EditPageBase.PageConfiguration

EditPageBase.ComponentCommand(FormComponentCommandModel, CancellationToken)

EditPageBase.Change(FormChangeCommandArguments)

EditPageBase.Submit(FormSubmissionCommandArguments)

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

TagCreate(IFormComponentMapper, IFormDataBinder, IPageLinkGenerator, IInfoProvider<TagInfo>)

Initializes a new instance of the TagCreate class.

public TagCreate(IFormComponentMapper formComponentMapper, IFormDataBinder formDataBinder, IPageLinkGenerator pageLinkGenerator, IInfoProvider<TagInfo> tagInfoProvider)

Parameters

formComponentMapper IFormComponentMapper

formDataBinder IFormDataBinder

pageLinkGenerator IPageLinkGenerator

tagInfoProvider IInfoProvider<TagInfo>

Properties

ParentTagID

Parent tag ID.

[PageParameter(typeof(IntPageModelBinder), typeof(TagEditLayout))]
public int ParentTagID { get; set; }

Property Value

int

TaxonomyID

Taxonomy ID.

[PageParameter(typeof(IntPageModelBinder), typeof(TaxonomyEditSection))]
public int TaxonomyID { get; set; }

Property Value

int

Methods

ConfigurePage()

Set up page's configuration. Configures UI page.

public override Task ConfigurePage()

Returns

Task

FinalizeInfoObject(TagInfo, IFormFieldValueProvider, CancellationToken)

Allows to modify values of infoObject before validation and saving.

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

Parameters

infoObject TagInfo

Info object to be set.

fieldValueProvider IFormFieldValueProvider

Provider of form field values.

cancellationToken CancellationToken

The cancellation instruction.

Returns

Task

GetFormItems()

Prepares form items for editing object of the specified ObjectType.

protected override Task<ICollection<IFormItem>> GetFormItems()

Returns

Task<ICollection<IFormItem>>

Returns the collection of form items.

GetSubmitSuccessResponse(TagInfo, ICollection<IFormItem>)

Response that has to be returned after successful form submission.

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

Parameters

savedInfoObject TagInfo

Object info after persisting.

items ICollection<IFormItem>

Collection with updated form items.

Returns

Task<ICommandResponse>

SaveAndCreateAnother(FormSubmissionCommandArguments)

Creates the tag and navigates to create another tag under the same parent.

public Task<ICommandResponse> SaveAndCreateAnother(FormSubmissionCommandArguments args)

Parameters

args FormSubmissionCommandArguments

Returns

Task<ICommandResponse>

SetFormData(TagInfo, IFormFieldValueProvider)

Sets the infoObject.

protected override Task SetFormData(TagInfo infoObject, IFormFieldValueProvider fieldValueProvider)

Parameters

infoObject TagInfo

Info object to be set.

fieldValueProvider IFormFieldValueProvider

Provider of form field values.

Returns

Task

ValidatePage()

Validates the page state prior invocation of the ConfigurePage() method.

public override Task<PageValidationResult> ValidatePage()

Returns

Task<PageValidationResult>