Table of Contents

Class WebPageBase<TClientProperties>

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

Base class of a page providing basic webpage identifiers in the context of the webpage application.

public abstract class WebPageBase<TClientProperties> : Page<TClientProperties>, IPage where TClientProperties : TemplateClientProperties, new()

Type Parameters

TClientProperties
Inheritance
object
Page<TClientProperties>
WebPageBase<TClientProperties>
Implements
Derived
Inherited Members
Extension Methods

Remarks

Checks webpage's READ permission.

Constructors

WebPageBase(IAuthenticatedUserAccessor, IWebPageManagerFactory, IContentLanguageRetriever, IPageUrlGenerator)

Initializes an instance of the WebPageBase<TClientProperties> class.

[Obsolete("Use WebPageBase(IAuthenticatedUserAccessor userAccessor, IWebPageManagerFactory webPageManagerFactory, IPageLinkGenerator pageLinkGenerator) instead.")]
[ObsoleteSince(29, 2)]
public WebPageBase(IAuthenticatedUserAccessor userAccessor, IWebPageManagerFactory webPageManagerFactory, IContentLanguageRetriever contentLanguageRetriever, IPageUrlGenerator pageUrlGenerator)

Parameters

userAccessor IAuthenticatedUserAccessor
webPageManagerFactory IWebPageManagerFactory
contentLanguageRetriever IContentLanguageRetriever
pageUrlGenerator IPageUrlGenerator

WebPageBase(IAuthenticatedUserAccessor, IWebPageManagerFactory, IPageLinkGenerator)

Initializes an instance of the WebPageBase<TClientProperties> class.

public WebPageBase(IAuthenticatedUserAccessor userAccessor, IWebPageManagerFactory webPageManagerFactory, IPageLinkGenerator pageLinkGenerator)

Parameters

userAccessor IAuthenticatedUserAccessor
webPageManagerFactory IWebPageManagerFactory
pageLinkGenerator IPageLinkGenerator

WebPageBase(IAuthenticatedUserAccessor, IWebPageManagerFactory, IPageUrlGenerator)

Initializes an instance of the WebPageBase<TClientProperties> class.

[Obsolete("Use WebPageBase(IAuthenticatedUserAccessor userAccessor, IWebPageManagerFactory webPageManagerFactory, IPageLinkGenerator pageLinkGenerator) instead.")]
[ObsoleteSince(29, 5)]
public WebPageBase(IAuthenticatedUserAccessor userAccessor, IWebPageManagerFactory webPageManagerFactory, IPageUrlGenerator pageUrlGenerator)

Parameters

userAccessor IAuthenticatedUserAccessor
webPageManagerFactory IWebPageManagerFactory
pageUrlGenerator IPageUrlGenerator

Properties

ApplicationIdentifier

Application identifier.

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

Property Value

WebPagesApplicationUrlIdentifier

WebPageIdentifier

Web page identifier composed of web page ID and language ID.

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

Property Value

WebPageUrlIdentifier

Methods

CheckAclPermission(int, string, CancellationToken)

Checks whether the user has given ACL permission.

protected Task CheckAclPermission(int webPageItemId, string permissionName, CancellationToken cancellationToken = default)

Parameters

webPageItemId int

Web page item identifier.

permissionName string

Name of the ACL permission.

cancellationToken CancellationToken

Cancellation token.

Returns

Task

Exceptions

ForbiddenAccessException

If user does not have the given permission for specified web page.

ConfigurePage()

Allows configure and share page specific values prior invocation of the ConfigureTemplateProperties(TClientProperties) or command method.

public override Task ConfigurePage()

Returns

Task

ConfigureTemplateProperties(TClientProperties)

Gets the object representing client side template properties.

public override Task<TClientProperties> ConfigureTemplateProperties(TClientProperties properties)

Parameters

properties TClientProperties

Initialized properties object.

Returns

Task<TClientProperties>