Table of Contents

Class ContentItemEdit

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

Page for editing the content item.

public sealed class ContentItemEdit : ContentItemEditPageBase, IPage
Inheritance
object
ContentItemEdit
Implements
Inherited Members
Extension Methods

Constructors

ContentItemEdit(IFormDataBinder, IFormComponentCommandInvoker, IFormItemCollectionProvider, IContentItemManagerFactory, IAuthenticatedUserAccessor, IPageLinkGenerator, IContentLanguageRetriever, IContentItemDisplayNameValidator, IContentItemUIDataRetriever, IWorkflowStepRoleArbiter, ICoveringWorkflowRetriever, IContentItemWorkflowManagerFactory)

Initializes a new instance of ContentItemEdit

public ContentItemEdit(IFormDataBinder formDataBinder, IFormComponentCommandInvoker formComponentCommandInvoker, IFormItemCollectionProvider formItemCollectionProvider, IContentItemManagerFactory contentItemManagerFactory, IAuthenticatedUserAccessor userAccessor, IPageLinkGenerator pageLinkGenerator, IContentLanguageRetriever contentLanguageRetriever, IContentItemDisplayNameValidator contentItemDisplayNameValidator, IContentItemUIDataRetriever contentItemUIDataRetriever, IWorkflowStepRoleArbiter workflowStepRoleArbiter, ICoveringWorkflowRetriever coveringWorkflowRetriever, IContentItemWorkflowManagerFactory contentItemWorkflowManagerFactory)

Parameters

formDataBinder IFormDataBinder
formComponentCommandInvoker IFormComponentCommandInvoker
formItemCollectionProvider IFormItemCollectionProvider
contentItemManagerFactory IContentItemManagerFactory
userAccessor IAuthenticatedUserAccessor
pageLinkGenerator IPageLinkGenerator
contentLanguageRetriever IContentLanguageRetriever
contentItemDisplayNameValidator IContentItemDisplayNameValidator
contentItemUIDataRetriever IContentItemUIDataRetriever
workflowStepRoleArbiter IWorkflowStepRoleArbiter
coveringWorkflowRetriever ICoveringWorkflowRetriever
contentItemWorkflowManagerFactory IContentItemWorkflowManagerFactory

Properties

ItemID

Item ID.

[PageParameter(typeof(IntPageModelBinder), typeof(ContentItemEditSection))]
public int ItemID { get; set; }

Property Value

int

Methods

CancelScheduledPublish(CancellationToken)

Cancels scheduled publish of the content item.

[PageCommand(CommandName = "CancelScheduledPublish")]
public Task<ICommandResponse> CancelScheduledPublish(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

CancelScheduledPublishAndEdit(CancellationToken)

Cancels scheduled publish of the content item and starts a new workflow.

[PageCommand(CommandName = "CancelScheduledPublishAndEdit")]
public Task<ICommandResponse> CancelScheduledPublishAndEdit(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

CancelScheduledUnpublish(CancellationToken)

Cancels scheduled unpublish of the content item.

[PageCommand(CommandName = "CancelScheduledUnpublish")]
public Task<ICommandResponse> CancelScheduledUnpublish(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

ChangeWorkflowStep(ContentItemSubmissionCommandArguments, CancellationToken)

Changes the content item workflow step.

[PageCommand(CommandName = "ChangeWorkflowStep")]
public Task<ICommandResponse> ChangeWorkflowStep(ContentItemSubmissionCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args ContentItemSubmissionCommandArguments

Change workflow step submit arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

ConfigureTemplateProperties(ContentItemClientProperties)

Gets the object representing client side template properties.

public override Task<ContentItemClientProperties> ConfigureTemplateProperties(ContentItemClientProperties properties)

Parameters

properties ContentItemClientProperties

Initialized properties object.

Returns

Task<ContentItemClientProperties>

CreateNewVersion(CancellationToken)

Creates new Draft version of content item.

[PageCommand(CommandName = "CreateNewVersion")]
public Task<ICommandResponse> CreateNewVersion(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Delete(CancellationToken)

Deletes the InitialDraft version of content item.

[PageCommand(CommandName = "Delete")]
public Task<ICommandResponse> Delete(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Discard(CancellationToken)

Discards the Draft version of content item.

[PageCommand(CommandName = "Discard")]
public Task<ICommandResponse> Discard(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

GetFormComponentCommandFormComponents(FormComponentCommandModel, CancellationToken)

Gets the form components for the form component command.

protected override Task<ICollection<IFormComponent>> GetFormComponentCommandFormComponents(FormComponentCommandModel commandModel, CancellationToken cancellationToken = default)

Parameters

commandModel FormComponentCommandModel

Form component command arguments.

cancellationToken CancellationToken

The cancellation instruction.

Returns

Task<ICollection<IFormComponent>>

Returns the form components valid for the specific command.

InitializeContext(CancellationToken)

Initializes form context.

protected override Task<IFormContext> InitializeContext(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<IFormContext>

Publish(ContentItemSubmissionCommandArguments, CancellationToken)

Publishes the content item.

[PageCommand(CommandName = "Publish")]
public Task<ICommandResponse> Publish(ContentItemSubmissionCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args ContentItemSubmissionCommandArguments

Publish submit arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Rename(RenameCommandArguments, CancellationToken)

Updates content item display name.

[PageCommand]
public Task<ICommandResponse> Rename(RenameCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args RenameCommandArguments

Rename command arguments.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse>

Save(ContentItemSubmissionCommandArguments, CancellationToken)

Saves the changes in the content item.

[PageCommand(CommandName = "Save")]
public Task<ICommandResponse> Save(ContentItemSubmissionCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args ContentItemSubmissionCommandArguments

Arguments

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Unpublish(CancellationToken)

Redirects to the page with unpublishing options.

[PageCommand(CommandName = "Unpublish")]
public Task<ICommandResponse> Unpublish(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

ValidatePage()

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

public override Task<PageValidationResult> ValidatePage()

Returns

Task<PageValidationResult>

Versions(ContentItemSubmissionCommandArguments, CancellationToken)

Shows content item versions.

Versions submit arguments. Cancellation token. 
[PageCommand(CommandName = "Versions")]
public Task<ICommandResponse> Versions(ContentItemSubmissionCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args ContentItemSubmissionCommandArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse>