Class UIDescriptor

Represents a UI descriptor for a content type (which could be page, block, etc...), which will be used to render UI for a specific content.

Inheritance

System.Object

UIDescriptor

UIDescriptor<T>

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: EPiServer.Shell

Assembly: EPiServer.Shell.dll

Version: 8.11.0

Syntax

public class UIDescriptor

Constructors

UIDescriptor(Type)

Initializes a new instance of the UIDescriptor class.

Declaration

public UIDescriptor(Type forType)

Parameters

Type	Name	Description
System.Type	forType	The type to describe.

UIDescriptor(Type, String)

Initializes a new instance of the UIDescriptor class.

Declaration

protected UIDescriptor(Type forType, string iconClass)

Parameters

Type	Name	Description
System.Type	forType	The described CLR type.
System.String	iconClass	Represents CSS class name which will be used to display an icon for the type.

UIDescriptor(Type, String, IEnumerable<String>)

Initializes a new instance of the UIDescriptor class.

Declaration

protected UIDescriptor(Type forType, string iconClass, IEnumerable<string> dndTypes)

Parameters

Type	Name	Description
System.Type	forType	The described CLR type.
System.String	iconClass	Represents CSS class name which will be used to display an icon for the type.
System.Collections.Generic.IEnumerable<System.String>	dndTypes	An array with the drag and drop types that the item type represents.

Remarks

Only use this overload if you want to specifically register custom drag and drop types.

Properties

AvailableViews

Gets or sets the available views.

Declaration

public IEnumerable<ViewConfiguration> AvailableViews { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<ViewConfiguration>	The available views.

BaseTypeIdentifier

Gets the base type identifier, that is: the closest parent in the inheritance chain.

Declaration

public string BaseTypeIdentifier { get; set; }

Property Value

Type	Description
System.String

BaseTypes

Gets or sets a list of the base types and interfaces that the item type directly inherited from.

Declaration

public IEnumerable<string> BaseTypes { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<System.String>

CommandIconClass

Gets or sets the icon class for commands for this type.

Declaration

public string CommandIconClass { get; set; }

Property Value

Type	Description
System.String

ContainerTypeIdentifier

Represents the class that parent object in the hierarchy haves, for instance "episerver.core.pagedata".

Declaration

[Obsolete("Use ContainerTypes instead")]
public string ContainerTypeIdentifier { get; set; }

Property Value

Type	Description
System.String

ContainerTypes

Represents the types that can be parents to this type. For instance a ContentFolder for the BlockData type.

Declaration

public IEnumerable<Type> ContainerTypes { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<System.Type>

CreateView

Gets or sets the view to be shown when creating content for this UI descriptor.

Declaration

public string CreateView { get; set; }

Property Value

Type	Description
System.String

DefaultView

Gets or sets the default view for this UI descriptor.

Declaration

public string DefaultView { get; set; }

Property Value

Type	Description
System.String

DisabledViews

Gets or sets the disabled views.

Declaration

public ICollection<string> DisabledViews { get; protected set; }

Property Value

Type	Description
System.Collections.Generic.ICollection<System.String>	The disabled views.

DndTypes

An array with the drag and drop types that the item type represents.

Declaration

public ICollection<string> DndTypes { get; }

Property Value

Type	Description
System.Collections.Generic.ICollection<System.String>

ForType

Gets or sets connected CLR type.

Declaration

public Type ForType { get; set; }

Property Value

Type	Description
System.Type

IconClass

Represents CSS class name which will be used to display an icon for the type.

Declaration

public string IconClass { get; set; }

Property Value

Type	Description
System.String

IsPrimaryType

Flag indicates creating content is primary type or not

Declaration

public bool IsPrimaryType { get; set; }

Property Value

Type	Description
System.Boolean

LanguageKey

The unique key for the child node to the contenttypes node.

Declaration

public string LanguageKey { get; set; }

Property Value

Type	Description
System.String

Remarks

This value will default to the class name with lower case. Set this property to the path of the XML element that contains the label and description elements in one of your localization providers. (for instance an xml file in the /lang directory.)

MainWidgetType

Defines the main widget that is responsible for showing the user interface when an instance of this type is loaded in the client context.

Declaration

[Obsolete("Use view configurations instead")]
public string MainWidgetType { get; set; }

Property Value

Type	Description
System.String

PublishView

Gets or sets the view to be shown after publishing content for this UI descriptor.

Declaration

public string PublishView { get; set; }

Property Value

Type	Description
System.String

SortKey

Gets or sets the sort column.

Declaration

public SortColumn SortKey { get; set; }

Property Value

Type	Description
SortColumn

TypeIdentifier

Type's identifier. Used to replace CLR type's fully qualified name.

Declaration

public string TypeIdentifier { get; set; }

Property Value

Type	Description
System.String

Methods

AddDisabledView(String)

Add a view to the list of disabled views.

Declaration

public void AddDisabledView(string viewName)

Parameters

Type	Name	Description
System.String	viewName