Custom Products module: Create the definitions class

After you Custom Products module: Create the web service of for the Products module, you create the module's definition class. You use the definitions class for building the user interface (UI) of the backend and the frontend views of the module. To create the definitions class:

1. Navigate to ProductsModule » Web, open the context menu of the UI folder and click Add » Class.
2. Name the class file ProductsDefinitions.cs and click Add.
3. Open the ProductsDefinitions.cs file and add the following using statements:
   using ProductCatalogSample.Model;

   using ProductCatalogSample.Web.Controls;

   using ProductCatalogSample.Web.UI.Public;

   using Telerik.Sitefinity.Abstractions;

   using Telerik.Sitefinity.Configuration;

   using Telerik.Sitefinity.Localization;

   using Telerik.Sitefinity.Localization.Configuration;

   using Telerik.Sitefinity.Localization.Web.UI;

   using Telerik.Sitefinity.Model.ContentLinks;

   using Telerik.Sitefinity.Modules;

   using Telerik.Sitefinity.Modules.Pages;

   using Telerik.Sitefinity.Services;

   using Telerik.Sitefinity.Taxonomies;

   using Telerik.Sitefinity.Versioning;

   using Telerik.Sitefinity.Versioning.Web.UI.Config;

   using Telerik.Sitefinity.Versioning.Web.UI.Views;

   using Telerik.Sitefinity.Web;

   using Telerik.Sitefinity.Web.UI;

   using Telerik.Sitefinity.Web.UI.Backend.Elements.Config;

   using Telerik.Sitefinity.Web.UI.Backend.Elements.Enums;

   using Telerik.Sitefinity.Web.UI.Backend.Elements.Widgets;

   using Telerik.Sitefinity.Web.UI.ContentUI.Config;

   using Telerik.Sitefinity.Web.UI.ContentUI.Views.Backend.Detail;

   using Telerik.Sitefinity.Web.UI.ContentUI.Views.Backend.Master;

   using Telerik.Sitefinity.Web.UI.ContentUI.Views.Backend.Master.Config;

   using Telerik.Sitefinity.Web.UI.Extenders.Config;

   using Telerik.Sitefinity.Web.UI.Fields;

   using Telerik.Sitefinity.Web.UI.Fields.Config;

   using Telerik.Sitefinity.Web.UI.Fields.Enums;

   using Telerik.Sitefinity.Web.UI.Validation.Config;
4. Define the following static constructor:
   static ProductsDefinitions()

   {

       // Ensure Products module is initialized.

       SystemManager.GetApplicationModule(ProductsModule.ModuleName);

   }

   You create the ModuleName constant in a later section of this tutorial. For more information, see Custom Products module: Implement the module class.

5. Define the following constants:
   /// <summary>

   /// Frontend definitoin name

   /// </summary>

   public const string FrontendDefinitionName = "ProductsFrontend";

   /// <summary>

   /// Detail view definition

   /// </summary>

   public const string FrontendDetailViewName = "ProductsFrontendDetails";

   /// <summary>

   /// Master view definition

   /// </summary>

   public const string FrontendListViewName = "ProductsFrontendList";

    

   /// <summary>

   /// Name of the view that displays only titles

   /// </summary>

   public const string FrontendTitlesOnlyListViewName = "Products sample list - Titles only";

   /// <summary>

   /// Name of the view that displays titles and days

   /// </summary>

   public const string FrontendTitlesDatesListViewName = "Products sample list - Titles and dates";

   /// <summary>

   /// Name of the view that displays title,s dates and full content

   /// </summary>

   public const string FrontendTitlesDatesContentsListViewName = "Products sample list  - Titles, dates and full content";

   /// <summary>

   /// Name of the view that displays titles, dates and summary

   /// </summary>

   public const string FrontendTitlesDatesSummariesListViewName = "Products sample list - Titles, dates and summaries";

   /// <summary>

   /// Name of the view that displays the whole product item

   /// </summary>

   public const string FrontendFullProductItemDetailViewName = "Products sample - Full product";

   /// <summary>

   /// Definition name for the frontend commments list.

   /// </summary>

   public static readonly string FrontendCommentsDefinitionName = "ProductsCommentsFrontend";

   #endregion

    

   #region Commands

   /// <summary>

   /// Common name for the command used to create a new item.

   /// </summary>

   public const string CreateCommandName = "create";

    

   /// <summary>

   /// Common name for the command used to save an item.

   /// </summary>

   public const string SaveCommandName = "save";

    

   /// <summary>

   /// Common name for a command used to cancel an operation.

   /// </summary>

   public const string CancelCommandName = "cancel";

    

   /// <summary>

   /// Common name used for a command that saves an item and resets the entry form.

   /// </summary>

   public const string SaveAndContinueCommandName = "saveAndContinue";

    

   /// <summary>

   /// Common name used for a command that publishes an item.

   /// </summary>

   public const string PublishCommandName = "publish";

    

   /// <summary>

   /// Common name used for a command that unpublishes an item.

   /// </summary>

   public const string UnpublishCommandName = "unpublish";

    

   /// <summary>

   /// Common name used for a command that performs a batch publish

   /// </summary>

   public const string GroupPublishCommandName = "groupPublish";

    

   /// <summary>

   /// Common name used for a command that edits an item.

   /// </summary>

   public const string EditCommandName = "edit";

   /// <summary>

   /// Common name used for a command that performs a batch unpublish

   /// </summary>

   public const string GroupUnpublishCommandName = "groupUnpublish";

    

   /// <summary>

   /// Common name used for a command that delets an item.

   /// </summary>

   public const string DeleteCommandName = "delete";

    

   /// <summary>

   /// Common name used for a command that displays the history of an item

   /// </summary>

   public const string HistoryCommandName = "history";

    

   /// <summary>

   /// Common name used for a command that opens an item in a preview mode.

   /// </summary>

   public const string PreviewCommandName = "preview";

    

   /// <summary>

   /// Common name used for a command that shows the permissions for a given secured

   /// object.

   /// </summary>

   public const string PermissionsCommandName = "permissions";

    

   /// <summary>

   /// Common name used for a command that displays the history of an item.

   /// </summary>

   public const string HistoryGridCommandName = "historygrid";

    

   #endregion
6. Define DefineProductsBackendContentView and DefineProductsFrontendContentView methods in the following way:
   public static ContentViewControlElement DefineProductsBackendContentView(ConfigElement parent)

   {

       throw new NotImplementedException();

   }

    

   public static ContentViewControlElement DefineProductsFrontendContentView(ConfigElement parent)

   {

       throw new NotImplementedException();

   }

   NOTE: You implement the methods in the code above later in this tutorial. In the methods you must return a ContentViewControlElement object that contains the UI for the respective view. For more information, see Custom Products module: Create the backend view and Custom Products module: Create the frontend view.

   You must call the DefineLocationsBackendContentView and the DefineLocationsFrontendContentView methods from the configuration class. For more information, see For developers: Implement the configuration element.