Class UIPageAttribute

Namespace

Kentico.Xperience.Admin.Base

Assembly

Kentico.Xperience.Admin.Base.dll

Registers an administration UI page within the application.

[AttributeUsage(AttributeTargets.Assembly, AllowMultiple = true)]
public class UIPageAttribute : Attribute

Inheritance

object

Attribute

UIPageAttribute

Derived

UIApplicationAttribute

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

UIPageAttribute(Type, string, Type, string, string, int)

Initializes new instance of UIPageAttribute.

public UIPageAttribute(Type parentType, string slug, Type uiPageType, string name, string templateName, int order)

Parameters

parentType Type

Parent page type.

slug string

Url slug.

uiPageType Type

UI page type.

name string

Name.

templateName string

Template name.

order int

Order of the page.

UIPageAttribute(Type, string, Type, string, string, int, string)

Initializes new instance of UIPageAttribute.

[Obsolete("Use the constructor without the icon parameter instead. Use the setter to set value of the Icon property.")]
[ObsoleteSince(29, 5)]
public UIPageAttribute(Type parentType, string slug, Type uiPageType, string name, string templateName, int order, string icon)

Parameters

parentType Type

Parent page type.

slug string

Url slug.

uiPageType Type

UI page type.

name string

Name.

templateName string

Template name.

order int

Order of the page.

icon string

Page icon.

Properties

Icon

Category icon.

public string Icon { get; set; }

Property Value

string

Name

Name of the item to be displayed to users.

public string Name { get; }

Property Value

string

Order

Order of the page.

public int Order { get; }

Property Value

int

ParameterDefaultValue

Default value of a parametrized page URL parameter.

public string ParameterDefaultValue { get; set; }

Property Value

string

Remarks

The default value is used when generating link for the page.

See Also

PARAMETERIZED_SLUG

ParentType

Type of the parent page within the UI tree.

public Type ParentType { get; }

Property Value

Type

Slug

Part of the URL under which the page is reachable within the UI tree.

public string Slug { get; }

Property Value

string

TemplateName

Template name

public string TemplateName { get; }

Property Value

string

Type

Type of the page to be registered within the UI.

public Type Type { get; }

Property Value

Type

See Also

Attribute