Don't miss out Virtual Happy Hour this Friday (April 26).

Try our conversational search powered by Generative AI!

Class CmsModule

Inheritance
System.Object
CmsModule
Namespace: EPiServer.Cms.Shell
Assembly: EPiServer.Cms.Shell.UI.dll
Version: 11.20.7
Syntax
public class CmsModule : ShellModule

Constructors

CmsModule(String, String, String)

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

CmsModule(String, String, String, Uri, Uri, Func<String, String>, ITypeScannerLookup, VirtualPathProvider, IEnumerable<IContentRepositoryDescriptor>, CmsUIDefaults, CategoryRepository, DisplayResolutionService, ServiceAccessor<SiteDefinition>, EPiServerSection, Settings, IFrameRepository, IProjectService, ServiceAccessor<RequestContext>)

Declaration
[Obsolete("The constructor will be removed in next breaking change. Please use the constructor with ServiceAccessor<ExternalApplicationOptions>>")]
public CmsModule(string name, string routeBasePath, string resourceBasePath, Uri uiUrl, Uri utilUrl, Func<string, string> absolutePathConverter, ITypeScannerLookup typeScannerLookup, VirtualPathProvider vpp, IEnumerable<IContentRepositoryDescriptor> contentRepositoryDescriptors, CmsUIDefaults cmsUiDefaults, CategoryRepository categoryRepository, DisplayResolutionService displayResolutionService, ServiceAccessor<SiteDefinition> currentSiteDefinition, EPiServerSection episerverSection, Settings settings, IFrameRepository frameRepository, IProjectService projectService, ServiceAccessor<RequestContext> requestContext)
Parameters
Type Name Description
System.String name
System.String routeBasePath
System.String resourceBasePath
System.Uri uiUrl
System.Uri utilUrl
System.Func<System.String, System.String> absolutePathConverter
ITypeScannerLookup typeScannerLookup
System.Web.Hosting.VirtualPathProvider vpp
System.Collections.Generic.IEnumerable<IContentRepositoryDescriptor> contentRepositoryDescriptors
CmsUIDefaults cmsUiDefaults
CategoryRepository categoryRepository
DisplayResolutionService displayResolutionService
ServiceAccessor<SiteDefinition> currentSiteDefinition
EPiServerSection episerverSection
Settings settings
IFrameRepository frameRepository
IProjectService projectService
ServiceAccessor<System.Web.Routing.RequestContext> requestContext

CmsModule(String, String, String, Uri, Uri, Func<String, String>, ITypeScannerLookup, VirtualPathProvider, IEnumerable<IContentRepositoryDescriptor>, CmsUIDefaults, CategoryRepository, DisplayResolutionService, ServiceAccessor<SiteDefinition>, EPiServerSection, Settings, IFrameRepository, IProjectService, ServiceAccessor<RequestContext>, IFeatureNotificationService)

Declaration
[Obsolete("The constructor will be removed in next breaking change. Please use the constructor with ServiceAccessor<ExternalApplicationOptions>>")]
public CmsModule(string name, string routeBasePath, string resourceBasePath, Uri uiUrl, Uri utilUrl, Func<string, string> absolutePathConverter, ITypeScannerLookup typeScannerLookup, VirtualPathProvider vpp, IEnumerable<IContentRepositoryDescriptor> contentRepositoryDescriptors, CmsUIDefaults cmsUiDefaults, CategoryRepository categoryRepository, DisplayResolutionService displayResolutionService, ServiceAccessor<SiteDefinition> currentSiteDefinition, EPiServerSection episerverSection, Settings settings, IFrameRepository frameRepository, IProjectService projectService, ServiceAccessor<RequestContext> requestContext, IFeatureNotificationService featureNotificationService)
Parameters
Type Name Description
System.String name
System.String routeBasePath
System.String resourceBasePath
System.Uri uiUrl
System.Uri utilUrl
System.Func<System.String, System.String> absolutePathConverter
ITypeScannerLookup typeScannerLookup
System.Web.Hosting.VirtualPathProvider vpp
System.Collections.Generic.IEnumerable<IContentRepositoryDescriptor> contentRepositoryDescriptors
CmsUIDefaults cmsUiDefaults
CategoryRepository categoryRepository
DisplayResolutionService displayResolutionService
ServiceAccessor<SiteDefinition> currentSiteDefinition
EPiServerSection episerverSection
Settings settings
IFrameRepository frameRepository
IProjectService projectService
ServiceAccessor<System.Web.Routing.RequestContext> requestContext
IFeatureNotificationService featureNotificationService

CmsModule(String, String, String, Uri, Uri, Func<String, String>, ITypeScannerLookup, VirtualPathProvider, IEnumerable<IContentRepositoryDescriptor>, CmsUIDefaults, CategoryRepository, DisplayResolutionService, ServiceAccessor<SiteDefinition>, EPiServerSection, Settings, IFrameRepository, IProjectService, ServiceAccessor<RequestContext>, IFeatureNotificationService, ServiceAccessor<ExternalApplicationOptions>)

Declaration
public CmsModule(string name, string routeBasePath, string resourceBasePath, Uri uiUrl, Uri utilUrl, Func<string, string> absolutePathConverter, ITypeScannerLookup typeScannerLookup, VirtualPathProvider vpp, IEnumerable<IContentRepositoryDescriptor> contentRepositoryDescriptors, CmsUIDefaults cmsUiDefaults, CategoryRepository categoryRepository, DisplayResolutionService displayResolutionService, ServiceAccessor<SiteDefinition> currentSiteDefinition, EPiServerSection episerverSection, Settings settings, IFrameRepository frameRepository, IProjectService projectService, ServiceAccessor<RequestContext> requestContext, IFeatureNotificationService featureNotificationService, ServiceAccessor<ExternalApplicationOptions> externalApplicationOptionsAccessor)
Parameters
Type Name Description
System.String name
System.String routeBasePath
System.String resourceBasePath
System.Uri uiUrl
System.Uri utilUrl
System.Func<System.String, System.String> absolutePathConverter
ITypeScannerLookup typeScannerLookup
System.Web.Hosting.VirtualPathProvider vpp
System.Collections.Generic.IEnumerable<IContentRepositoryDescriptor> contentRepositoryDescriptors
CmsUIDefaults cmsUiDefaults
CategoryRepository categoryRepository
DisplayResolutionService displayResolutionService
ServiceAccessor<SiteDefinition> currentSiteDefinition
EPiServerSection episerverSection
Settings settings
IFrameRepository frameRepository
IProjectService projectService
ServiceAccessor<System.Web.Routing.RequestContext> requestContext
IFeatureNotificationService featureNotificationService
ServiceAccessor<ExternalApplicationOptions> externalApplicationOptionsAccessor

CmsModule(String, String, String, Uri, Uri, Func<String, String>, ITypeScannerLookup, VirtualPathProvider, IEnumerable<IContentRepositoryDescriptor>, CmsUIDefaults, CategoryRepository, DisplayResolutionService, ServiceAccessor<SiteDefinition>, EPiServerSection, Settings, IFrameRepository, IProjectService, ServiceAccessor<RequestContext>, IFeatureNotificationService, ServiceAccessor<RoutingOptions>)

Declaration
[Obsolete("The constructor will be removed in next breaking change. Please use the constructor with ServiceAccessor<ExternalApplicationOptions>>")]
public CmsModule(string name, string routeBasePath, string resourceBasePath, Uri uiUrl, Uri utilUrl, Func<string, string> absolutePathConverter, ITypeScannerLookup typeScannerLookup, VirtualPathProvider vpp, IEnumerable<IContentRepositoryDescriptor> contentRepositoryDescriptors, CmsUIDefaults cmsUiDefaults, CategoryRepository categoryRepository, DisplayResolutionService displayResolutionService, ServiceAccessor<SiteDefinition> currentSiteDefinition, EPiServerSection episerverSection, Settings settings, IFrameRepository frameRepository, IProjectService projectService, ServiceAccessor<RequestContext> requestContext, IFeatureNotificationService featureNotificationService, ServiceAccessor<RoutingOptions> routingOptionsAccessor)
Parameters
Type Name Description
System.String name
System.String routeBasePath
System.String resourceBasePath
System.Uri uiUrl
System.Uri utilUrl
System.Func<System.String, System.String> absolutePathConverter
ITypeScannerLookup typeScannerLookup
System.Web.Hosting.VirtualPathProvider vpp
System.Collections.Generic.IEnumerable<IContentRepositoryDescriptor> contentRepositoryDescriptors
CmsUIDefaults cmsUiDefaults
CategoryRepository categoryRepository
DisplayResolutionService displayResolutionService
ServiceAccessor<SiteDefinition> currentSiteDefinition
EPiServerSection episerverSection
Settings settings
IFrameRepository frameRepository
IProjectService projectService
ServiceAccessor<System.Web.Routing.RequestContext> requestContext
IFeatureNotificationService featureNotificationService
ServiceAccessor<RoutingOptions> routingOptionsAccessor

CmsModule(String, String, String, Uri, Uri, Func<String, String>, ITypeScannerLookup, VirtualPathProvider, IEnumerable<IContentRepositoryDescriptor>, CmsUIDefaults, CategoryRepository, DisplayResolutionService, ServiceAccessor<SiteDefinition>, EPiServerSection, Settings, IFrameRepository, IProjectService, ServiceAccessor<RequestContext>, IFeatureNotificationService, ServiceAccessor<RoutingOptions>, ServiceAccessor<ExternalApplicationOptions>)

Declaration
[Obsolete("The constructor will be removed in next breaking change. Please use the constructor with ServiceAccessor<ExternalApplicationOptions>>")]
public CmsModule(string name, string routeBasePath, string resourceBasePath, Uri uiUrl, Uri utilUrl, Func<string, string> absolutePathConverter, ITypeScannerLookup typeScannerLookup, VirtualPathProvider vpp, IEnumerable<IContentRepositoryDescriptor> contentRepositoryDescriptors, CmsUIDefaults cmsUiDefaults, CategoryRepository categoryRepository, DisplayResolutionService displayResolutionService, ServiceAccessor<SiteDefinition> currentSiteDefinition, EPiServerSection episerverSection, Settings settings, IFrameRepository frameRepository, IProjectService projectService, ServiceAccessor<RequestContext> requestContext, IFeatureNotificationService featureNotificationService, ServiceAccessor<RoutingOptions> routingOptionsAccessor, ServiceAccessor<ExternalApplicationOptions> externalApplicationOptionsAccessor)
Parameters
Type Name Description
System.String name
System.String routeBasePath
System.String resourceBasePath
System.Uri uiUrl
System.Uri utilUrl
System.Func<System.String, System.String> absolutePathConverter
ITypeScannerLookup typeScannerLookup
System.Web.Hosting.VirtualPathProvider vpp
System.Collections.Generic.IEnumerable<IContentRepositoryDescriptor> contentRepositoryDescriptors
CmsUIDefaults cmsUiDefaults
CategoryRepository categoryRepository
DisplayResolutionService displayResolutionService
ServiceAccessor<SiteDefinition> currentSiteDefinition
EPiServerSection episerverSection
Settings settings
IFrameRepository frameRepository
IProjectService projectService
ServiceAccessor<System.Web.Routing.RequestContext> requestContext
IFeatureNotificationService featureNotificationService
ServiceAccessor<RoutingOptions> routingOptionsAccessor
ServiceAccessor<ExternalApplicationOptions> externalApplicationOptionsAccessor

Methods

CreateViewModel(ModuleTable, IClientResourceService)

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

GetHelpUrl()

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

Extension Methods