November Happy Hour will be moved to Thursday December 5th.

Class ShellModule

Inheritance
System.Object
ShellModule
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.Shell.Modules
Assembly: EPiServer.Shell.dll
Version: 11.20.7
Syntax
public class ShellModule

Constructors

ShellModule(String, String, String)

Declaration
public ShellModule(string name, string routeBasePath, string resourceBasePath)
Parameters
Type Name Description
System.String name
System.String routeBasePath
System.String resourceBasePath

ShellModule(String, String, String, ITypeScannerLookup, VirtualPathProvider)

Declaration
public ShellModule(string name, string routeBasePath, string resourceBasePath, ITypeScannerLookup typeScannerLookup, VirtualPathProvider virtualPathProvider)
Parameters
Type Name Description
System.String name
System.String routeBasePath
System.String resourceBasePath
ITypeScannerLookup typeScannerLookup
System.Web.Hosting.VirtualPathProvider virtualPathProvider

Properties

Assemblies

Declaration
public IEnumerable<Assembly> Assemblies { get; set; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<System.Reflection.Assembly>

ClientResourcePath

Declaration
public string ClientResourcePath { get; set; }
Property Value
Type Description
System.String

Controllers

Declaration
public IEnumerable<Type> Controllers { get; set; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<System.Type>

Manifest

Declaration
public ShellModuleManifest Manifest { get; set; }
Property Value
Type Description
ShellModuleManifest

Name

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String

ResourceBasePath

Declaration
public string ResourceBasePath { get; set; }
Property Value
Type Description
System.String

RouteBasePath

Declaration
public string RouteBasePath { get; set; }
Property Value
Type Description
System.String

Methods

CreateViewModel(ModuleTable, IClientResourceService)

Declaration
public virtual ModuleViewModel CreateViewModel(ModuleTable moduleTable, IClientResourceService clientResourceService)
Parameters
Type Name Description
ModuleTable moduleTable
IClientResourceService clientResourceService
Returns
Type Description
ModuleViewModel

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean
Overrides
System.Object.Equals(System.Object)

GetControllerType(String)

Declaration
public Type GetControllerType(string controllerName)
Parameters
Type Name Description
System.String controllerName
Returns
Type Description
System.Type

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.Object.GetHashCode()

GetHelpUrl()

Declaration
public virtual string GetHelpUrl()
Returns
Type Description
System.String

GetResolvedRouteBasePath()

Declaration
public string GetResolvedRouteBasePath()
Returns
Type Description
System.String

GetRouteForController(String)

Declaration
public RouteDescription GetRouteForController(string controllerName)
Parameters
Type Name Description
System.String controllerName
Returns
Type Description
RouteDescription

GetRouteSegmentForController(String)

Declaration
public string GetRouteSegmentForController(string controllerName)
Parameters
Type Name Description
System.String controllerName
Returns
Type Description
System.String

Merge(ShellModule)

Declaration
public void Merge(ShellModule module)
Parameters
Type Name Description
ShellModule module

MergeDuplicateModules(IEnumerable<ShellModule>)

Declaration
public static IEnumerable<ShellModule> MergeDuplicateModules(IEnumerable<ShellModule> modules)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<ShellModule> modules
Returns
Type Description
System.Collections.Generic.IEnumerable<ShellModule>

ResolveClientPath(String)

Declaration
[Obsolete("Use ModuleTable.ResolveClientPath instead", false)]
public string ResolveClientPath(string moduleRelativePath)
Parameters
Type Name Description
System.String moduleRelativePath
Returns
Type Description
System.String

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()

Extension Methods