Sitefinity CMS

Telerik.Framework Send comments on this topic.
WebModule Class
See Also  Members   Example 
Telerik Namespace : WebModule Class


Base class for implementation of a Sitefinity module.

 

Namespace: Telerik
Assembly: Telerik.Framework (in Telerik.Framework.dll)

Syntax

Visual Basic (Declaration) 
Public MustInherit Class WebModule 
   Implements IModuleIWebModule 
Visual Basic (Usage)Copy Code
Dim instance As WebModule
C# 
public abstract class WebModule : IModuleIWebModule  

Example

The following example shows how to implement the Telerik.Web.WebModule abstract class to create new Sitefinity module. The main purpose is to initialize a ControlPanel control and to provide information for the addition of a two public controls in the toolbox when editing a page.
C#Copy Code
/// <summary>
/// The main class that allows the module to integrate into Sitefinity. It must derive from the
/// WebModule class and implement the required abstract methods.
/// </summary>
public class JobModule : WebModule
{
   #region Properties

   
/// <summary>
   
/// Name of the module.
   
/// </summary>
   
public override string Name
   {
       get {
return "jobsPluggable"; }
   }

   
/// <summary>
   
/// Title of the module that is displayed in navigation.
   
/// </summary>
   
/// <remarks>
   
/// Store/retrieve the value in the resource file.
   
/// </remarks>
   
public override string Title
   {
       get {
return "Jobs(Pluggable)"; }
   }

   
/// <summary>
   
/// Description of the module.
   
/// </summary>
   
/// <remarks>
   
/// Store/retrieve the value in the resource file.
   
/// </remarks>
   
public override string Description
   {
       get {
return "A module to maintain job listings implemented using the Pluggable approach"; }
   }

   
/// <summary>
   
/// Gets ToolboxItemCollection with all ToolboxItem objects which register the corresponding control for use in the public part of the CMS system.
   
/// </summary>
   
public override IList<IToolboxItem> Controls
   {
       get
       {
           
return new List<IToolboxItem>(new ToolboxItem[] { new JobListToolboxItem(), new JobListSummaryToolboxItem() });
       }
   }
}
    

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also