episerver.shell
Describes the <episerver.shell> section of the configuration file.
The Configure CMS topic describes the syntax of the configuration elements.
<episerver.shell>
<dashboard>
<navigation>
<protectedModules>
<publicModules>
</episerver.shell>
<dashboard>
<dashboard defaultService="string" >
<disabledGadgets>
<add name="string" />
...
</disabledGadgets>
<templates>
<add forRoles="string" >
<tabs>
<add layout="string"
name="string" >
<gadgets>
<add column="int"
name="string" >
</gadgets>
</add>
...
</tabs>
...
</templates>
</dashboard>
<disabledGadgets>/<add> element attributes
Name | Default value | Description |
name | Required. The class name, including namespace, of the gadget to be disabled. |
<templates>/<add> element attributes
Name | Default value | Description |
forRoles | Required. Comma-separated list of roles for which the template should apply. |
<tabs>/<add> element attributes
Name | Default value | Description |
layout | Required. The name of the layout to be used on this tab. Example: “2 Column”. | |
name | Required. The name of the tab. |
<gadgets>/<add> element attributes
<navigation>
<navigation>
<add alignment="MenuItemAlignment"
menuItemType="MenuItemType"
menuPath="string"
sortIndex="int"
target="string"
text="string"
url="string" />
...<br /></navigation>
<navigation> element attributes
Name | Default value | Description |
alignment | MenuItemAlignment.Left | The alignment of the menu item. Possible values are Left and Right. |
menuItemType | MenuItemType.Link | The type of this menu item. Possible values are Link, Section and DropDown. Link items must be children of container items, either a Section or a DropDown. The hierarchy of menu items is controlled by the menuPath attribute. |
menuPath | Required. The menu path/key of this menu item. The path defines the structure and is also the unique key to this menu item. “/global/” refers to the full menu area, menuPath must start with “/global/” to be visible in the menu. |
|
sortIndex | The sort index of this menu item. Menu items are sorted from low to high within each section. | |
target | The frame in which to open the linked file. | |
text | Required. The text that should appear in the menu item. | |
url | The URL of the file to be opened. |
<protectedModules>
<protectedModules autoDiscovery="AutoDiscoveryLevel"
rootPath="string" >
<add clientResorcePath="string"
name="string"
resourcePath="string" >
<assemblies>
<add assembly="string" />
...
</assemblies>
</add><br /> ...
</protectedModules>
<protectedModules> element attributes
Name | Default value | Description |
autoDiscovery | AutoDiscoveryLevel.Minimal | Option for probing the the module folder and load of module assemblies automatically on start-up. Possible values are:
|
rootPath | Required. The root path below which module directories are located. |
<protectedModules>/<add> element attributes
Name | Default value | Description |
clientResourcePath | The client resource path. If no value is specified the resourcePath is used. | |
name | Required. The name of the module/folder. If no resourcePath value is specified the name value is combined with the rootPath value to form the path to the module folder. | |
resourcePath | The path to the module directory. |
<assemblies>/<add> element attributes
Name | Default value | Description |
assembly | Required. An assembly to load and associate with the module. The assemblies listed in this collection may be combined with assemblies defined by the module depending on the auto discovery option. |
<publicModules>
<publicModules autoDiscovery="AutoDiscoveryLevel"
rootPath="string" >
<add clientResorcePath="string"
name="string"
resourcePath="string" >
<assemblies>
<add assembly="string" />
...
</assemblies>
</add>
...
</publicModules>
<publicModules> element attributes
Name | Default value | Description |
autoDiscovery | AutoDiscoveryLevel.Minimal | Option for probing the the module folder and load of module assemblies automatically on start-up. Possible values are:
|
rootPath | Required. The root path below which module directories are located. |
<publicModules>/<add> element attributes
Name | Default value | Description |
clientResourcePath | The client resource path. If no value is specified the resourcePath is used. | |
name | Required. The name of the module/folder. If no resourcePath value is specified the name value is combined with the rootPath value to form the path to the module folder. | |
resourcePath | The path to the module directory. |
<assemblies>/<add> element attributes
Name | Default value | Description |
assembly | Required. An assembly to load and associate with the module. The assemblies listed in this collection may be combined with assemblies defined by the module depending on the auto discovery option. |
Updated 4 months ago
Next