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: February 25, 2015 @ 2:00 p.m. ET / 11:00 a.m. PT Secure Shell (SSH) keys provide unmitigated access for privileged users and applications. However, managing and securing these critical privileged credentials poses a real challenge for organizations, putting sensitive data at risk. In fact, more than 50% of organizations report experiencing an SSH Key related compromise. Check out this upcoming eSeminar and join Adam Bosnian, EVP of Global Business Development at CyberArk, as he discusses the …

  • Today's agile organizations pose operations teams with a tremendous challenge: to deploy new releases to production immediately after development and testing is completed. To ensure that applications are deployed successfully, an automatic and transparent process is required. We refer to this process as Zero Touch Deployment™. This white paper reviews two approaches to Zero Touch Deployment--a script-based solution and a release automation platform. The article discusses how each can solve the key …

Most Popular Programming Stories

More for Developers

RSS Feeds

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