Class ViewConfiguration

Class to define configuration of sparrowhawk(R) view for specific type.

Inheritance

System.Object

ViewConfiguration

ViewConfiguration<T>

Implements

ISortable

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 abstract class ViewConfiguration : ISortable

Constructors

ViewConfiguration(Type)

Initializes a new instance of the ViewConfiguration class.

Declaration

protected ViewConfiguration(Type forType)

Parameters

Type	Name	Description
System.Type	forType	For type.

Properties

Type	Description
System.String

ControllerType

Gets the full identifier for the controller used to represent the view, for instance "mynamespace/widget/widgettype".

Declaration

public string ControllerType { get; set; }

Property Value

Type	Description
System.String	The type of the controller.

Description

Gets or sets the description.

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String	The description.

ForType

Gets or sets for type.

Declaration

public Type ForType { get; set; }

Property Value

Type	Description
System.Type	For type.

HideFromViewMenu

Gets or sets the show on view menu.

Declaration

public bool HideFromViewMenu { get; set; }

Property Value

Type	Description
System.Boolean	The show on view menu.

IconClass

Gets or sets the icon class.

Declaration

public string IconClass { get; set; }

Property Value

Type	Description
System.String	The icon class.

Key

Gets the key that's used to find this view configuration.

Declaration

public string Key { get; set; }

Property Value

Type	Description
System.String	The key.

LanguagePath

Gets or sets the language path.

Declaration

public string LanguagePath { get; set; }

Property Value

Type	Description
System.String	The name.

Name

Gets or sets the name.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String	The name.

PlugInAreas

Gets or sets the plug-in areas where you can select the view.

Declaration

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

Property Value

Type	Description
System.Collections.Generic.IEnumerable<System.String>	The plug-in areas.

SortOrder

Used to sort items that implements this interface. Trumphed by Category which is used to group the items (items without category will be considered a group too). Sort order will be respected within the group and the groups will be ordered by the lowest sort order within each group.

Declaration

public int SortOrder { get; set; }

Property Value

Type	Description
System.Int32

ViewType

Gets the full identifier for the widget used to represent the view, for instance "mynamespace/widget/widgettype".

Declaration

public string ViewType { get; set; }

Property Value

Type	Description
System.String	The type of the view.

Implements

ISortable