Interface IPageUrlGenerator

Namespace

Kentico.Xperience.Admin.Base

Assembly

Kentico.Xperience.Admin.Base.dll

Interface provides contract for URL generation within the Admin UI.

[Obsolete("Use IPageLinkGenerator instead.")]
[ObsoleteSince(29, 5)]
public interface IPageUrlGenerator

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Methods

GenerateUrl(Type, params string[])

Generates a rooted URL to an administration page.

string GenerateUrl(Type pageType, params string[] parameters)

Parameters

pageType Type

Page type to generate the URL for.

parameters string[]

Parameter values to be substituted into the URL. Provide the parameters in the same order as they would appear in the URL.

Returns

string

Generated URL.

Exceptions

ArgumentNullException

Thrown when pageType or parameters are null.

InvalidOperationException

Thrown when parameters contains too many or too little elements or pageType is not registered using the UIPageAttribute.

GenerateUrl<TPage>(params string[])

Generates a rooted URL to an administration page.

string GenerateUrl<TPage>(params string[] parameters)

Parameters

parameters string[]

Parameter values to be substituted into the URL. Provide the parameters in the same order as they would appear in the URL.

Returns

string

Generated URL.

Type Parameters

TPage

Page type to generate the URL for.

Exceptions

ArgumentNullException

Thrown when parameters is null.

InvalidOperationException

Thrown when parameters contains too many or too little elements or TPage is not registered using the UIPageAttribute.