DotNetNuke Tip: Module Setting - Display module on all pages
Welcome back to my series of DotNetNuke Tips. To get the tips program started back off I'll start with one of the most commonly used, commonly abused, and misunderstood options within the DotNetNuke application. That being the option on the modules settings for "Display Module On All Pages". To find this setting you must go to the Settings from the Module Actions for the module in question.
Once you are on the Settings page you can expand the Advanced Settings header to see the checkbox for Display Module On All Pages.
So now that you know how to find this setting, let's talk about what it actually does. In its simplest form this setting will do exactly what it says, it will display the module you're configuring on every page created in your portal (not including admin or host pages). A more detailed explanation would be that the module will display in the pane of the same name as the on the original instance of the module exists in when the setting is applied. If one of the skins for the pages of your site does not contain a pane with the same name the module will default to show up in the ContentPane. There's one other catch to the "Pane" settings, in my experience by assigning a module to be displayed on all pages, it will be displayed at the top of whatever pane it is positioned in, and you will not be able to move it from this top position, even if you want another module to be on top.
The other downfall of this setting is that it will do exactly what the description entails, it will display this module on every single page of your site. If you're running a recent version of DotNetNuke you have something working in your favor: in more recent versions of DNN you can actually delete modules that are marked as display on all pages from individual pages. In older versions this wasn't possible, if you removed it, it was removed from all pages at that time.
So, what if you want to remove the module from all pages in a portal? You need to first go to the module settings and uncheck the Display On All Pages option, you don't have to do this from the original module, you can do this from any of the "copies" on any of the pages. Once you do this, the module will no longer be displayed on any of the other pages of the site, it will only be displayed on the page you are currently on, after this you can delete the module from this page and make it go away.
So there it is, a quick introduction to the Display Module On All Pages option in the module settings, and the restart of my blogging series of DotNetNuke Tips, I'll post more DotNetNuke Tips each week come back for more later.