Table of Contents

Class Page<TClientProperties>

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

Base class for pages with properties.

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

Type Parameters

TClientProperties
Inheritance
object
Page<TClientProperties>
Implements
Derived
Extension Methods

Properties

EventLogService

Gets the current event log service.

protected IEventLogService EventLogService { get; }

Property Value

IEventLogService

LocalizationService

Gets the current localization service.

protected ILocalizationService LocalizationService { get; }

Property Value

ILocalizationService

Methods

ConfigurePage()

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

public virtual Task ConfigurePage()

Returns

Task

ConfigureTemplateProperties(TClientProperties)

Gets the object representing client side template properties.

public abstract Task<TClientProperties> ConfigureTemplateProperties(TClientProperties properties)

Parameters

properties TClientProperties

Initialized properties object.

Returns

Task<TClientProperties>

GetDefaultRoute(IEnumerable<Route>)

Gets the route which is redirected to, when no route is selected.

protected virtual Route GetDefaultRoute(IEnumerable<Route> routes)

Parameters

routes IEnumerable<Route>

Returns

Route

NavigateTo(string, bool)

Returns a command response that redirects to a URL in the admin application.

protected INavigateResponse NavigateTo(string navigationUrl, bool refetchAllTemplates = false)

Parameters

navigationUrl string

URL to redirect in the administration application.

refetchAllTemplates bool

Indicates that data in all templates will be re-fetched.

Returns

INavigateResponse

Remarks

This response does not execute the command CommandName on the client.

See Also

Response()

Returns a page command response.

protected ICommandResponse Response()

Returns

ICommandResponse

ResponseFrom<TResult>(TResult)

Returns a page command response from the passed result.

protected ICommandResponse<TResult> ResponseFrom<TResult>(TResult result)

Parameters

result TResult

Result of the command processed on the client template.

Returns

ICommandResponse<TResult>

Type Parameters

TResult

Type of the returned result.

Remarks

The result is passed to the templates's command after handler.

ValidatePage()

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

public virtual Task<PageValidationResult> ValidatePage()

Returns

Task<PageValidationResult>