ASP.NET Tip: Create a BasePage Class for All Pages to Share

Something I've been doing with my ASP.NET applications is creating a shared Page class from which all my Web pages inherit. This allows all the pages to share common functions, settings, and so forth without having to do much work. In ASP.NET 1.1, I used the BasePage class to help control the rendering of the page, but the Master Page in ASP.NET 2.0 eliminated this requirement.

To create a BasePage, you just add a class to your project. In 2.0, this class will go into the App_Code folder. It will inherit from System.Web.UI.Page, so the beginnings of the class will look like the following (C#):

public class BasePage : System.Web.UI.Page
{
}

Once you have the class, you'll need to change your ASP.NET pages to inherit from this class instead of directly from System.Web.UI.Page. Your revised code-behind file for a Web page will resemble the following:

public partial class MyPage : BasePage
{
   protected void Page_Load(object sender, EventArgs e)
   {
   }
}

Now that you have the inheritance set up between the two files, you can add common elements to the BasePage class and make them available to the Web page. For instance, a database-driven Web application might want to automatically open a database connection on each page. You can add this code to the OnInit event of the BasePage class, like so:

public class BasePage : System.Web.UI.Page
{
   public SqlConnection ActiveConnection;
   protected override void OnInit(EventArgs e)
   {
      ActiveConnection = new SqlConnection(...);
      ActiveConnection.Open();
   }
}

The variable named ActiveConnection will now be a live database connection available to any Web page. You'll also want to add the corresponding Close code to the OnUnload event if you open the connection in this manner.

The other thing to remember is that any variables declared as private in the BasePage won't be visible to the Web page, and any variables declared as protected in the BasePage won't be available to the ASPX portion of the Web page, but they will be available to the code-behind part of the ASPX page.

Future tips will discuss properties that instantiate objects when they are first requested rather than every time like this code does. You may have pages where a database connection isn't always required, so this adds time that isn't necessary.

About the Author

Eric Smith is the owner of Northstar Computer Systems, a Web-hosting company based in Indianapolis, Indiana. He is also a MCT and MCSD who has been developing with .NET since 2001. In addition, he has written or contributed to 12 books covering .NET, ASP, and Visual Basic.



Comments

  • Great idea!

    Posted by Neo An on 12/05/2012 07:35am

    Thanks for sharing this! Your instruction is very clear!

    Reply
Leave a Comment
  • Your email address will not be published. All fields are required.

Top White Papers and Webcasts

  • Live Event Date: March 19, 2015 @ 1:00 p.m. ET / 10:00 a.m. PT The 2015 Enterprise Mobile Application Survey asked 250 mobility professionals what their biggest mobile challenges are, how many employees they are equipping with mobile apps, and their methods for driving value with mobility. Join Dan Woods, Editor and CTO of CITO Research, and Alan Murray, SVP of Products at Apperian, as they break down the results of this survey and discuss how enterprises are using mobile application management and private …

  • This report outlines the future look of Forrester's solution for security and risk (S&R) executives working on building an identity and access management strategy for the extended enterprise. We designed this report to help you understand and navigate the major business and IT trends affecting identity and access management (IAM) during the next five years. IAM in 2012 has become a tool not just for security but also for business agility. Competitive challenges push businesses into the cloud and encourage …

Most Popular Programming Stories

More for Developers

RSS Feeds

Thanks for your registration, follow us on our social networks to keep up-to-date