Class ContentTab

Namespace

Kentico.Xperience.Admin.Websites.UIPages

Assembly

Kentico.Xperience.Admin.Websites.dll

Page for editing web page structured content.

public sealed class ContentTab : WebPageBase<ContentTabClientProperties>, IPage

Inheritance

object

Page<ContentTabClientProperties>

WebPageBase<ContentTabClientProperties>

ContentTab

Implements

IPage

Inherited Members

WebPageBase<ContentTabClientProperties>.ApplicationIdentifier

WebPageBase<ContentTabClientProperties>.WebPageIdentifier

WebPageBase<ContentTabClientProperties>.ConfigurePage()

Page<ContentTabClientProperties>.ValidatePage()

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

ContentTab(IWebPageManagerFactory, IAuthenticatedUserAccessor, IFormComponentCommandInvoker, IContentItemUIDataRetriever, IPageLinkGenerator)

Initializes a new instance of ContentTab

public ContentTab(IWebPageManagerFactory webPageManagerFactory, IAuthenticatedUserAccessor userAccessor, IFormComponentCommandInvoker formComponentCommandInvoker, IContentItemUIDataRetriever contentItemUIDataRetriever, IPageLinkGenerator pageLinkGenerator)

Parameters

webPageManagerFactory IWebPageManagerFactory

userAccessor IAuthenticatedUserAccessor

formComponentCommandInvoker IFormComponentCommandInvoker

contentItemUIDataRetriever IContentItemUIDataRetriever

pageLinkGenerator IPageLinkGenerator

Methods

Archive(CancellationToken)

Archives the web page.

[Obsolete("Archive status was replaced by Unpublished status, use Unpublish instead.")]
[ObsoleteSince(29, 2)]
public Task<ICommandResponse> Archive(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

CancelScheduledPublish(CancellationToken)

Cancels scheduled publish of the web page.

public Task<ICommandResponse> CancelScheduledPublish(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

CancelScheduledPublishAndEdit(CancellationToken)

Cancels scheduled publish of the web page and allows edit.

public Task<ICommandResponse> CancelScheduledPublishAndEdit(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

CancelScheduledUnpublish(CancellationToken)

Cancels scheduled unpublish of the web page.

public Task<ICommandResponse> CancelScheduledUnpublish(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

CascadePublish(PublishWebPageCommandArguments, CancellationToken)

Updates the web page and redirects to the publish page.

[Obsolete("Use Publish command instead.")]
[ObsoleteSince(29, 1)]
public Task<ICommandResponse> CascadePublish(PublishWebPageCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args PublishWebPageCommandArguments

Cascade publish submit arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Change(FormChangeCommandArguments, CancellationToken)

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

public Task<ICommandResponse<FormChangeResult>> Change(FormChangeCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args FormChangeCommandArguments

Form change arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<FormChangeResult>>

ChangeWorkflowStep(PublishWebPageCommandArguments, CancellationToken)

Changes the web page workflow step.

public Task<ICommandResponse> ChangeWorkflowStep(PublishWebPageCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args PublishWebPageCommandArguments

Change workflow step submit arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

ComponentCommand(FormComponentCommandModel, CancellationToken)

Handles the form component command invocation.

public Task<object> ComponentCommand(FormComponentCommandModel commandModel, CancellationToken cancellationToken)

Parameters

commandModel FormComponentCommandModel

Form component command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<object>

Returns the form component command result.

ConfigureTemplateProperties(ContentTabClientProperties)

Gets the object representing client side template properties.

public override Task<ContentTabClientProperties> ConfigureTemplateProperties(ContentTabClientProperties properties)

Parameters

properties ContentTabClientProperties

Initialized properties object.

Returns

Task<ContentTabClientProperties>

CreateNewVersion(CancellationToken)

Creates new Draft version of a web page.

public Task<ICommandResponse> CreateNewVersion(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Discard(CancellationToken)

Discards the Draft version of web page.

public Task<ICommandResponse> Discard(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

MoveItemFormChange(FormChangeCommandArguments, CancellationToken)

Handles the change command for confirmation dialog. The command is invoked whenever visibility conditions or form component configurators of the form need to be reevaluated to re-render the form.

public Task<ICommandResponse<FormChangeResult>> MoveItemFormChange(FormChangeCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args FormChangeCommandArguments

Form change command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<FormChangeResult>>

Publish(PublishWebPageCommandArguments, CancellationToken)

Updates the web page and redirects to the publish page.

public Task<ICommandResponse> Publish(PublishWebPageCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args PublishWebPageCommandArguments

Publish web page submit arguments

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Rename(RenameCommandArguments, CancellationToken)

Updates web pages display name.

public Task<ICommandResponse> Rename(RenameCommandArguments args, CancellationToken cancellationToken)

Parameters

args RenameCommandArguments

Rename command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Save(FormSubmissionCommandArguments, CancellationToken)

Saves page data changes.

public Task<ICommandResponse> Save(FormSubmissionCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args FormSubmissionCommandArguments

Submission arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Unpublish(CancellationToken)

Redirects to the page with unpublishing options.

public Task<ICommandResponse> Unpublish(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Versions(VersionsWebPageCommandArguments, CancellationToken)

Redirects to the page with web page versions.

public Task<ICommandResponse> Versions(VersionsWebPageCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args VersionsWebPageCommandArguments

Versions web page submit arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>