Interface IPageLinkGenerator

Namespace

Kentico.Xperience.Admin.Base

Assembly

Kentico.Xperience.Admin.Base.dll

Interface provides contract for link generation within the Admin UI.

public interface IPageLinkGenerator

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Methods

GetPath(Type, PageParameterValues)

Generates a rooted link to an administration page.

string GetPath(Type pageType, PageParameterValues pageParameterValues = null)

Parameters

pageType Type

Page type to generate the link for.

pageParameterValues PageParameterValues

Parameter values to be substituted into the link.

Returns

string

Generated link.

Remarks

PageParameterValues are serialized using System.Convert.ToString(object, System.IFormatProvider) when generating the link.

Exceptions

ArgumentNullException

Thrown when pageType is null.

InvalidOperationException

Thrown when the pageType is not registered in the application. Thrown when a parameter for a certain page type is missing. Thrown if too many parameters are specified when generating the link.

GetPath<TPage>(PageParameterValues)

Generates a rooted link to an administration page.

string GetPath<TPage>(PageParameterValues pageParameterValues = null)

Parameters

pageParameterValues PageParameterValues

Parameter values to be substituted into the link.

Returns

string

Generated link.

Type Parameters

TPage

Page type to generate the link for.

Remarks

PageParameterValues are serialized using System.Convert.ToString(object, System.IFormatProvider) when generating the link.

Exceptions

InvalidOperationException

Thrown when the TPage is not registered in the application. Thrown when a parameter for a certain page type is missing. Thrown if too many parameters are specified when generating the link.