SystemWebCompanion

In many ASP.NET web applications, there are some small bits of code that you have to write over and over again. They're too small so you never bother to refactor them out as a reusable dll. After all they are so small that it's very fast to create from scratch again. They end up as a Utils.cs file somewhere in your project, probably repeated in all your projects in one form or another.

Suffering from the same disease, I decided to create a small project for that. Its name is SystemWebCompanion. Its goal to create various small conveniences that ASP.NET web applications usually need.

The following features are currently included (version 1.1.0):

  • Extension method to get the application path terminated with a slash (how many times have you coded this one?)
  • Extension method to log an exception using log4net (and the inner exceptions too)
  • Common page title prefix for every page in the application. Useful for apps where every page's title begins with some common text, such as the site's title.
  • Web control to render the Google Analytics script, with the ability to turn it off for local development.

Not much, but at least you'll never have to code them again!

The project is hosted at SourceForge. If you use NuGet, you can already search for SystemWebCompanion in the online gallery.

Let's see some examples on how to use the forementioned features.

The methods to get the application path terminated with a slash:

// bring extension methods in scope
using System.Web.Companion;

// get the application path. "/" for sites, "/myapp/" for virtual directories.
string path = Request.SlashedAppPath();

// get the absolute application path. "http://mysite/" for sites,
// "http://mysite/myapp/" for virtual directories. string absolutePath = Request.AbsoluteAppPath();

 

To use the common title prefix, you need to use a master page and derive from the CompanionMasterPage class:

using System.Web.Companion;

[SiteTitlePrefix("My Web Site", " - ")]
public class MyMasterPage : CompanionMasterPage {
}

 

To use the Google Analytics web control:

<swc:GoogleAnalytics runat="server" SiteId="UA-1234-123" />

// by default it will not render on localhost. If you want it:
<swc:GoogleAnalytics runat="server" SiteId="UA-1234-123" 
    ShowOnLocalhost="true" />

 

Note that swc tag prefix. It stands for SystemWebCompanion. If you install via NuGet, your web.config will be modified automatically to register the swc prefix.

Hope this helps.

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s