Class PageExtender<TPage>

Namespace

Kentico.Xperience.Admin.Base

Assembly

Kentico.Xperience.Admin.Base.dll

Base class for page extenders allowing modify page properties and invoke custom commands.

public abstract class PageExtender<TPage> where TPage : class, IPage

Type Parameters

TPage

Inheritance

object

PageExtender<TPage>

Derived

ContentTypeEditSectionExtender

HeadlessChannelEditSectionExtender

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Properties

CommandExecute

The command handler for registering events that are invoked before and after command execution.

protected PageCommandHandler CommandExecute { get; }

Property Value

PageCommandHandler

Remarks

The PageCommandEventArgs contain the name of the executed command to filter out the desired command to handle. Commands are named using the PageCommandAttribute usually using the name of the annotated method.

Page

The extended page.

protected TPage Page { get; }

Property Value

TPage

Methods

ConfigurePage()

Allows modify page configuration object.

public virtual Task ConfigurePage()

Returns

Task

ConfigureTemplateProperties(TemplateClientProperties)

Allows modify template properties for specific page.

public virtual Task<TemplateClientProperties> ConfigureTemplateProperties(TemplateClientProperties properties)

Parameters

properties TemplateClientProperties

Properties configured by page.

Returns

Task<TemplateClientProperties>

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 refetched.

Returns

INavigateResponse

Remarks

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

See Also

GetPath(Type, PageParameterValues)

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.