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.

Adding Core Taxonomy to Your Module: Part 3 – Entities

In this part of the series I dive into details about Entities and what you, the module developer, must know when integrating taxonomy into your custom module. If you have not yet reviewed Part 1 and Part 2 of the series, please take the time to do so before reading this blog entry. Something to touch on prior to beginning is that for this blog entry I will be referring to an entity called Entry. My Entry entity is in a class named EntryInfo and I will likely refer to this throughout this blog entry and future blog entries in this series. As mentioned throughout the series, I am assuming you already have a working custom module of your own which contains your own “EntryInfo” equivalent.


Although most of you are probably familiar with entities, please allow me to take a moment to explain exactly what I mean here (because I could easily mean one of so many different things). When I reference entities, or its singular form entity, I am simply referring to what many DotNetNuke module developers would equate to an ‘Info’ object (or multiple Info objects when referencing the plural entities). Recently, in any modules I have been working on that are new projects I have been creating a separate folder within my components folder named “Entities”. In this folder, I keep my class files that represent my ‘Info’ objects (Ex. MyModule\Components\Entities\MyEntityInfo.cs). Simple modules may have a single entity (or possibly none), while a complex module could have a very high number of entities (Ex. A simple article module may have only a single entity: one called Article; A forum module should have at least four: Group, Forum, Thread, and Post; The Core Forum module, on the other hand, actually has at least twenty I could think of.). Please do keep in mind that an entity should be named in its singular form since it represents a single instance of the object and typically a single row of data from the data store (Ex. Article and NOT Articles). Now, let’s dive into details about our example entity, Entry.

Entry is a single class (as discussed earlier) that contains multiple properties, located in an EntryInfo named file (which resides in MyModule\Components\Entities\EntryInfo.cs. Also note, I named my class EntryInfo too). The majority of the properties in this class correspond to columns within a table (for the sake of this discussion, let’s say my table is named MyCompany_ModuleName_Entry).

Sample MyCompany_ModuleName_Entry Table:

   1: EntryId [INT]
   2: MyContent [NVARCHAR](MAX)
   3: ModuleId [INT] -- FK to Modules table.
   4: ContentItemID [INT] -- FK to ContentItems table.
   5: CreatedByUserId [INT]
   6: CreatedOnDate [DATETIME]
   7: LastModifiedByUserId [INT]
   8: LastModifiedOnDate [DATETIME]

It is possible that, perhaps, you are not referencing a table and are using a view instead in your module to retrieve your entity (this is completely acceptable but for simplicity I will stick to referencing the table). Also worth mentioning is that, as the snippet says, the ModuleId and ContentItemID columns are foreign keys to the Modules and ContentItems tables. Having said that, let’s take a moment to look at EntryInfo.cs in greater detail.

Sample EntryInfo Class:

   1: public class EntryInfo
   2: {
   4:     #region Public Properties
   6:     public int EntryId { get; set; }
   8:     public string MyContent { get; set; }
  10:     public int ModuleId { get; set; }
  12:     public int CreatedByUserId { get; set; }
  14:     public DateTime CreatedOnDate { get; set; }
  16:     public int LastModifiedByUserId { get; set; }
  18:     public DateTime LastModifiedOnDate { get; set; }
  20:     //Not stored as columns
  21:     public int TotalRecords { get; set; }
  23:     #endregion
  25: }

This sample shouldn’t contain any surprises, so I will skip going line for line here. One line worth mentioning, however, is line 21. Many of you are may already be doing this, or something similar, in your own module but in case some of the readers have not let’s spend a moment discussing it. As you can probably tell, based on the comment in line 20, this is a property which is not stored as a column. In my retrieval stored procedures that return multiple records (or instances of an entity), I return TotalRecords as a total count of items for use where paging is utilized (ie. datagrids, datalist, etc.). Although I don’t want to spend time on further details regarding paging, if you are using any of the core data grids you will definitely need this or an equivalent.


Now that we have covered the basic EntityInfo class, we should get into the details of what you need to add to your own entity to utilize the core taxonomy. First, you need to have your class inherit from the core ContentItem class (under the DotNetNuke.Entities.Content namespace). The reason for this is that it will give us access to all of our ContenItem properties (which are stored in the ContentItems table of the Core). In doing this, there are a few things you should be made aware of. The first is that we are inheriting from a class that implements IHydratable. Because of this you must be careful with your column/property names. For example, if you have a property/column with the name of Content it could potentially conflict with the core Content Item’s Content property/column (we will get to why in just a minute). The second reason is that you will need to override a method in your EntryInfo class: Fill, which also calls FillInternal. To understand better, let’s take a look at the Fill method.

Sample EntryInfo’s Fill Method:

   1: public override void Fill(System.Data.IDataReader dr) {
   2:     //Call the base classes fill method to populate base class properties
   3:     base.FillInternal(dr);
   5:     EntryId = Null.SetNullInteger(dr["EntryId"]);
   6:     MyContent = Null.SetNullString(dr["MyContent"]);
   7:     ModuleId = Null.SetNullInteger(dr["ModuleId"]);
   8:     CreatedByUserId = Null.SetNullInteger(dr["CreatedByUserId"]);
   9:     CreatedOnDate = Null.SetNullDateTime(dr["CreatedOnDate"]);
  10:     LastModifiedByUserId = Null.SetNullInteger(dr["LastModifiedByUserId"]);
  11:     LastModifiedOnDate = Null.SetNullDateTime(dr["LastModifiedOnDate"]);
  12:     TotalRecords = Null.SetNullInteger(dr["TotalRecords"]);
  13: }

Line 3 calls the base classes FillInternal method (the base class being ContentItem). When you call it, and in turn pass it a data reader, this is where the conflict I mentioned before can occur (as the FillInternal method is populating the ContentItem object). If we use our example and renamed “MyContent” to “Content”, there would be a conflict here (the FillInternal and the Fill methods would populate the two items named “Content” with the same data). While this may not be a problem in many cases, it is certainly something to be aware of (As you can see, I left my audit columns named the same because I was not worried about the conflict). This also means that when you return entities using your stored procedure, you need to make sure you use an INNER JOIN on the ContentItems table (via ContentItemID, which is why you need to add this column to your own table as noted in the table columns we previously outlined in the code snippet above). Please also keep in mind that you can only return a single instance of the same name regardless of table prefix naming (meaning, you cannot return our example’s Content.Content value as well as MyCompany_ModuleName_Entry.Content in the stored procedure) otherwise you will get an error. We will get into more details of the stored procedure, including an example, in Part 4. Also, in case you are not already aware of it, you will need to utilize the DotNetNuke.Common.Utilities namespace for using the Null.x methods. One final item worth mentioning about this snippet is that when using the Fill method only items that are properly filled (meaning, you set the property within the method and also return it in your stored procedure) will be available in other classes within your module (technically, the properties will be available but they will not be populated and you will see blank values in the user interface).

The last consideration with regards to your IHydratable implementation is that you should consider overriding the KeyID property too, as shown in the code snippet below where I set it’s value equal to the primary key value used in my example table, EntryId.

Sample EntryInfo’s KeyID Property:

   1: public override int KeyID {
   2:     get { return EntryId; }
   3:     set { EntryId = value; }
   4: }

As per Charles, the KeyID property was initially added to handle FillDictionary in the CBO. As the name implies, this KeyID property is used as the key in a Dictionary. As time went on, an overload method was added to the CBO to create any Dictionary type. Now, I have seen some questions in the past about cases where a Key is a non-integer value. In which case, you can either exclude it or utilize one of the other methods. However you implement is up to you and your situation but I will continue to use this for my example throughout the series (Not trying to spend too much time on IHydratable here).

So, to bring it all together, you simply need to inherit from the ContentItem class in your entity. Then, you need to override the Fill method (which also calls the base classes FillInternal) and the KeyID property (if applicable) in addition to updating your retrieval stored procedures (to make sure you are getting valid data for the Content Item) and adding the ContentItemID column to your own entity table. In the next section, Part 4, we will be focusing on the DAL which should finally start bringing everything together.


There are currently no comments, be the first to post one.

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 (21)
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 (269)
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?