DotNetNuke Modules – PortalModuleBase

F03I0037 We’ve been through most of the basics now with respect to creating the View module of the DotNetNuke module set.  We will be moving on to the Settings module next.  But before we do, we need to review a few important properties and methods of the PortalModuleBase class that the view module inherits from.

This list will not be a complete list, but it will cover the most important APIs for this class.

API Description
LocalResourceFile This property returns the location of the resource file associated with this control.  Used in conjunction with internationalization.  We’ve already used this property in our previous example showing how to add actions.
ModuleId Each instance of the module gets a unique ID.  This property is that ID.  You should use this to access data that is instance specific.
ModulePath The root relative path to the location of the module.  This does not include the file name.  If you want the location of the file on the hard drive, you’ll need to use Server.MapPath() to convert it.
PortalAlias Holds the alias string used to access the site, the PortalId, and the alias ID.
PortalID Each portal gets its own ID.  In one application I wrote, I wanted every instance of the module to grab data from the same pool of data so I needed to use the PortalID as the unique identifier rather than the moduleID as is the recommended way.  You may have your own uses for this information.
PortalSettings Holds lots of information about the portal, most of which is set in site settings using the administrator account.
TabID Tells you what page the module is located on.
UserID Uniquely identifies the logged-in user.  If the value is -1, the user is not logged in.
UserInfo Gives you more specific information about the user, including:
- UserName
- FirstName
- LastName
- Roles

 

Other post in DotNetNuke - Module Development

Related Post

  • DotNetNuke Modules – Creating Base ModulesDotNetNuke Modules – Creating Base Modules Now that we have DotNetNuke installed into Visual Studio we can go ahead and create our first modules. Actually, creating the modules is pretty simple. But it is even easier to do it wrong, which...
  • DotNetNuke Modules – Module SettingsDotNetNuke Modules – Module Settings Since each instance of a module that we put on a page should be able to have it's own configuration information, it is necessary to have some place that will allow us to configure it. For examp...
  • DotNetNuke Modules – Labels w/ no HelpDotNetNuke Modules – Labels w/ no Help While the bulk of the labels you use on a module will be DotNetNuke labels, occasionally you want to be able to put text on the screen that doesn't need context help and doesn't need to be associat...
  • DotNetNuke Modules – Anatomy of the ViewDotNetNuke Modules – Anatomy of the View Now that we've laid the foundation of DotNetNuke modules, it is time to start looking at the specific modules. While it would be practically impossible to cover every detail and every API feature o...
  • DotNetNuke Modules – Where Stuff Shows UpDotNetNuke Modules – Where Stuff Shows Up We continue our series on creating DotNetNuke modules today by showing you where the various components of the module we created last week show up in DotNetNuke. Remember, last Thursday, we ...