Locations module: Implement the module class

After you Locations module: Implement the frontend and backend views, you create the module class. The module class wraps the entire functionality created for the module. To create the module class:

1. In Visual Studio, open the context menu of the LocationsModule project and click Add » Class.
2. Name the class file LocationsModule.cs and click Add.
3. Open the file LocationsModule.cs.
4. Add the following using statements:
   • using LocationsModule.Configuration;
   • using LocationsModule.Data;
   • using LocationsModule.Model;
   • using LocationsModule.Web.Services;
   • using LocationsModule.Web.UI;
   • using LocationsModule.Web.UI.Public;
   • using Telerik.Sitefinity;
   • using Telerik.Sitefinity.Abstractions;
   • using Telerik.Sitefinity.Abstractions.VirtualPath;
   • using Telerik.Sitefinity.Abstractions.VirtualPath.Configuration;
   • using Telerik.Sitefinity.Configuration;
   • using Telerik.Sitefinity.Data;
   • using Telerik.Sitefinity.Modules.ControlTemplates;
   • using Telerik.Sitefinity.Modules.GenericContent;
   • using Telerik.Sitefinity.Modules.Pages;
   • using Telerik.Sitefinity.Modules.Pages.Configuration;
   • using Telerik.Sitefinity.Services;
   • using Telerik.Sitefinity.Web.UI.ContentUI;
5. Make the LocationsModule class inherit the ContentModuleBase class:
   public class LocationsModule : ContentModuleBase

   {

   }
6. Define the ModuleName constant in the following way:
   public const string ModuleName = "Locations";
7. Override the Initialize method of the ContentModuleBase class.

   In this class you must register the configuration class for the module and the backend service. Use the following code for the method:

   public override void Initialize(ModuleSettings settings)

   {

       base.Initialize(settings);

    

       // initialize configuration file

       App.WorkWith()

           .Module(settings.Name)

           .Initialize()

               .Configuration<LocationsModuleConfig>()

               .WebService<LocationsBackendService>("Sitefinity/Services/Content/Locations.svc");

   }
8. Override the Install method of the ContentModuleBase class. The method installs the module in Sitefinity CMS system.
   public override void Install(SiteInitializer initializer)

   {

       base.Install(initializer);

     

       // register module ?

       IModule locationsModule;

       SystemManager.ApplicationModules.TryGetValue(LocationsModule.ModuleName, out locationsModule);

     

       initializer.Context.SaveMetaData(true);

       this.InstallCustomVirtualPaths(initializer);

   }

     

   private void InstallCustomVirtualPaths(SiteInitializer initializer)

   {

       var virtualPathConfig = initializer.Context.GetConfig<VirtualPathSettingsConfig>();

       ConfigManager.Executed += new EventHandler<ExecutedEventArgs>(ConfigManager_Executed);

       var locationsModuleVirtualPathConfig = new VirtualPathElement(virtualPathConfig.VirtualPaths)

       {

           VirtualPath = "~/LocationTemplates/*",

           ResolverName = "EmbeddedResourceResolver",

           ResourceLocation = "LocationsModule"

       };

       if (!virtualPathConfig.VirtualPaths.ContainsKey("~/LocationTemplates/*"))

           virtualPathConfig.VirtualPaths.Add(locationsModuleVirtualPathConfig);

   }

    

   private void ConfigManager_Executed(object sender, Telerik.Sitefinity.Data.ExecutedEventArgs args)

   {

       if (args.CommandName == "SaveSection")

       {

           var section = args.CommandArguments as VirtualPathSettingsConfig;

           if (section != null)

           {

               // Reset the VirtualPathManager whenever we save the VirtualPathConfig section.

               // This is needed so that our prefixes for the widget templates in the module assembly are taken into account.

               VirtualPathManager.Reset();

           }

       }

   }

   In the code above, in the InstallCustomVirtualPaths method you register the prefixes used by the LayoutTemplatePath properties of your frontend controls.

9. Define the LocationsPageGroupID and the LocationsModuleLandingPage constants in the following way:
   public static readonly Guid LocationsPageGroupID = new Guid("000262BF-E8EA-4BE3-8C67-E1C2486A57BE");

   public static readonly Guid LocationsModuleLandingPage = new Guid("7A0F43CE-064A-4E09-A3B9-59CA2E1640A6");

   You use these constants in the implementation of the InstallPages method.

10. Implement the abstract members of the ContentModuleBase class in the following way:
    protected override void InstallPages(SiteInitializer initializer)

    {

        initializer.Installer

            .CreateModuleGroupPage(LocationsPageGroupID, "Locations")

                .PlaceUnder(SiteInitializer.ModulesNodeId)

                .SetOrdinal(1)

                .SetTitle("Locations")

                .SetUrlName("Locations")

                .SetDescription("Module for managing a list of Locations")

                .AddChildPage(LandingPageId, "Locations")

                    .SetTitle("Locations")

                    .SetHtmlTitle("Locations")

                    .SetUrlName("Locations")

                    .SetDescription("Module for managing a list of Locations")

                    .AddContentView(b =>

                    {

                        b.ControlDefinitionName = LocationsDefinitions.BackendDefinitionName;

                    })

                    .Done();

    }

     

    public override void Upgrade(SiteInitializer initializer, Version upgradeFrom)

    {

        // not needed

    }

     

    protected override void InstallTaxonomies(SiteInitializer initializer)

    {

        this.InstallTaxonomy(initializer, typeof(LocationItem));

    }

     

    protected override ConfigSection GetModuleConfig()

    {

        // code to return Module configuration

        return Config.Get<LocationsModuleConfig>();

    }

     

    protected override void InstallConfiguration(SiteInitializer initializer)

    {

        // Module widget is installed on Bootstrapper_Initialized

        initializer.Installer

            .PageToolbox()

                .LoadOrAddSection("Locations")

                    .LoadOrAddWidget<LocationsView>("LocationsView")

                        .SetTitle("LocationsViewTitle")

                        .SetDescription("LocationsViewDescription")

                        .Done()

                    .Done()

                .Done();

    }

     

    public override Guid LandingPageId

    {

        get { return LocationsModuleLandingPage; }

    }

     

    public override Type[] Managers

    {

        get { return new[] { typeof(LocationsManager) }; }

    }