SaaS CMS has officially launched! Learn more now.

AI OnAI Off

Class ShellModuleManifest

Meta-data for a module. The manifest is parsed from the file module.config in the module's root directory.

Inheritance
System.Object
ShellModuleManifest
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.Configuration
Assembly: EPiServer.Shell.dll
Version: 8.11.0
Syntax
public class ShellModuleManifest

Constructors

ShellModuleManifest()

Initializes a new instance of the ShellModuleManifest class. Default value for LoadFromBin is true.

Declaration
public ShellModuleManifest()

Properties

Assemblies

A list of assemblies where modules will be loaded from.

Declaration
public List<AssemblyElement> Assemblies { get; set; }
Property Value
Type Description
System.Collections.Generic.List<AssemblyElement>

ClientModule

Gets or sets the client module settings.

Declaration
public ClientModule ClientModule { get; set; }
Property Value
Type Description
ClientModule

ClientResourceRelativePath

Gets or sets the client resource path relative to base resource module folder.

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

The relative client resource path.

ClientResources

Gets or sets the client resources provided by the module.

Declaration
public List<ClientResourceElement> ClientResources { get; set; }
Property Value
Type Description
System.Collections.Generic.List<ClientResourceElement>

Description

The description of the module

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

Dojo

Gets or sets the dojo configuration

Declaration
public DojoConfiguration Dojo { get; set; }
Property Value
Type Description
DojoConfiguration

DojoModules

Gets or sets the dojo modules provided by the shell module

Declaration
public List<DojoPath> DojoModules { get; set; }
Property Value
Type Description
System.Collections.Generic.List<DojoPath>
Remarks

This is obsolete, use Dojo.Paths instead.

HelpFile

Help file for the module

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

LoadFromBin

Indicates whether the application will look in all bin folders for modules.

Declaration
public bool LoadFromBin { get; set; }
Property Value
Type Description
System.Boolean

ProductName

Product name

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

Route

A definition of the routes for modules.

Declaration
public RouteDescription Route { get; set; }
Property Value
Type Description
RouteDescription
Remarks

Route is a quick entry to the first entry of the Routes collection.

RouteBasePath

Gets or sets the route base path.

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

The route base path.

Routes

A list of routes for the module.

Declaration
public List<RouteDescription> Routes { get; set; }
Property Value
Type Description
System.Collections.Generic.List<RouteDescription>

Tags

Modules tag

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

Type

Gets or sets the custom type for this module.

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

The custom type of the module.
Remarks

If not set, ShellModule will be used.

Version

Gets or sets the version for the shell module.

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

Methods

Deserialize(Stream)

Deserializes the stream into a ShellModuleManifest.

Declaration
public static ShellModuleManifest Deserialize(Stream manifestFileStream)
Parameters
Type Name Description
System.IO.Stream manifestFileStream

A stream containing the object serialized as xml.
Returns
Type Description
ShellModuleManifest

A ShellModuleManifest