Learn More





DNN Community Blog

The Community Blog is a personal opinion of community members and by no means the official standpoint of DNN Corp or DNN Platform. This is a place to express personal thoughts about DNNPlatform, the community and its ecosystem. Do you have useful information that you would like to share with the DNN Community in a featured article or blog? If so, please contact .

The use of the Community Blog is covered by our Community Blog Guidelines - please read before commenting or posting.

Look Mom - No Hands

Actually No User Controls.

While I was doing some work on 4.5.0, I decided to test whether DotNetNuke allowed developers to use Server Controls (Web Controls) as Module Controls.  While there are a few locations where it is assumed that web controls might be used, in some other areas assumptions were being made that module controls were always user controls (ending in .ascx).

In the 4.5.0 Release Candidate some of these areas were fixed to allow the use of Web Controls as Module Controls.  In this blog I'll show you how to create a "Hello World" module that only contains a single assembly.

1. Create a Class Library Project for the Module

First create a Class Library project (see below).

In this example I created a C# Class Library called (DotNetNuke.Modules.HelloWorld) and added a single C# class HelloWorldModule.cs (see below)

Note that this class inherits from PortalModuleBase - just like a User Control.  I have overriden the Render method to render the text "Hello World".

2. Build the Module

Add a reference in your DotNetNuke Website project to this new Class Library (so the Module gets built into the \bin folder), and set the Assembly name in the Project properties.  We will discuss packaging and deployment later.

So we now have an assembly in our \bin folder called DotNetNuke.Modules.HelloWorld.dll.

3. Register the Module

The next step is to register the module trhough the Module Definitions UI.  Add a new Module Definition as you would for any new module.  When adding the "View" module control, instead of using the selector that displays all the .ascx files in the DesktopModules folder, use the new textbox field to enter the Assembly Qualified Name of our Module control.  In this case DotNetNuke.Module.HelloWorld.HelloWorldModule, DotNetNuke.Module.HelloWorld  (ie. Namespace, Assembly).

The text box is not long enough to see the full name, but this can be clearly seen in the Controls list after creating the control.

4. Add Module to Page

Now we have registered the Module we can add the Module to our page as usual, and the result is:

Look Mom - No User Controls !!!

5. Packaging and Deployment

So far we have not created or used a folder for the Module.  The module project can "in theory" be located anywhere as long as it builds into the Websites \bin folder.  However, in order for localization to work we will need to create a physical "Hello World" fodler.  Also, as with WAP modules the built-in packager assumes that the project file (*.csproj) will be physically located in this folder.  Given this scenario, the core packager will create the correct installation package, which will contain two files (three for the source version)

  1. The assembly - DotNetNuke.Modules.HelloWorld.dll
  2. The manifest file - Hello World.dnn.config
  3. An optional source file Hello

The manifest is exactly how you would expect it to look.

Thats it - Just install it as you would any module. 

- Note: there was a minor fix that needed to be made to the installer that is not in the Release Candidate, but will be in the Public Release.


Comment Form

Only registered users may post comments.


2sic Daniel Mettler (124)
Aderson Oliveira (15)
Alec Whittington (11)
Alex Shirley (10)
Andrew Nurse (30)
Anthony Glenwright (5)
Antonio Chagoury (28)
Ash Prasad (22)
Ben Schmidt (1)
Benjamin Hermann (25)
Benoit Sarton (9)
Beth Firebaugh (12)
Bill Walker (36)
Bob Kruger (5)
Brian Dukes (2)
Brice Snow (1)
Bruce Chapman (20)
Bryan Andrews (1)
cathal connolly (55)
Charles Nurse (163)
Chris Hammond (203)
Chris Paterra (55)
Clinton Patterson (28)
Cuong Dang (21)
Daniel Bartholomew (2)
Dave Buckner (2)
David Poindexter (3)
David Rodriguez (2)
Doug Howell (11)
Erik van Ballegoij (30)
Ernst Peter Tamminga (74)
Geoff Barlow (6)
Gifford Watkins (3)
Gilles Le Pigocher (3)
Ian Robinson (7)
Israel Martinez (17)
Jan Blomquist (2)
Jan Jonas (3)
Jaspreet Bhatia (1)
Jenni Merrifield (6)
Joe Brinkman (270)
John Mitchell (1)
Jon Henning (14)
Jonathan Sheely (4)
Jordan Coopersmith (1)
Joseph Craig (2)
Kan Ma (1)
Keivan Beigi (3)
Ken Grierson (10)
Kevin Schreiner (6)
Leigh Pointer (31)
Lorraine Young (60)
Malik Khan (1)
Matthias Schlomann (15)
Mauricio Márquez (5)
Michael Doxsey (7)
Michael Tobisch (3)
Michael Washington (202)
Mike Horton (19)
Mitchel Sellers (28)
Nathan Rover (3)
Navin V Nagiah (14)
Néstor Sánchez (31)
Nik Kalyani (14)
Peter Donker (52)
Philip Beadle (135)
Philipp Becker (4)
Richard Dumas (22)
Robert J Collins (5)
Roger Selwyn (8)
Ruben Lopez (1)
Ryan Martinez (1)
Salar Golestanian (4)
Sanjay Mehrotra (9)
Scott McCulloch (1)
Scott S (11)
Scott Wilkinson (3)
Scott Willhite (97)
Sebastian Leupold (80)
Shaun Walker (237)
Shawn Mehaffie (17)
Stefan Cullmann (12)
Stefan Kamphuis (12)
Steve Fabian (31)
Timo Breumelhof (24)
Tony Henrich (3)
Torsten Weggen (2)
Vicenç Masanas (27)
Vincent Nguyen (3)
Vitaly Kozadayev (6)
Will Morgenweck (37)
Will Strohl (163)
William Severance (5)
Try Evoq
For Free
Start Free Trial
a Demo
See Evoq Live
Need More Information?