Click here to Skip to main content
15,347,735 members
Articles / Web Development / ASP.NET
Article
Posted 11 May 2007

Stats

224.8K views
3.9K downloads
97 bookmarked

Developing an ASP.NET page with MasterPage and Localization

Rate me:
Please Sign up or sign in to vote.
4.57/5 (51 votes)
15 Nov 2014CPOL2 min read
The MasterPage is derived from UserControl and thus, does not support the method 'InitializeCulture()'; a bit more coding is required in order to make the ASP.NET MasterPage localizable.

Introduction

While seeking on the internet for a solution to implement localization within an ASP.NET application using a MasterPage, I realized that a lot of people have got the same problem to solve. Unfortunately, I could not find a suitable solution thus, I intended to do my own implementation.

Background

The solution presented within this article uses the standard localization mechanism of the .NET framework.

Using the code

The published solution uses the Session object as storage for the currently selected culture. This will be initialized during the Session_Start method that is part of the global.asax file.

If a culture change is requested by the user, the MasterPage changes the stored culture in the Session object.

In a BasePage that inherits from Page, the method InitializeCulture is overridden and sets the appropriate culture information stored in the Session object to the current thread. Therefore, every Web Form needs to derive from this BasePage.

Let's start with the Global.asax file:

C#
void Session_Start(object sender, EventArgs e) 
{
    //set english as default startup language
    Session["MyCulture"] = "en-GB";
}

Alternatively, the culture can be defined in the Web.config file with the key <globalization culture="en-GB" /> and then be processed and stored in the Session object from the Session_Start method.

The next step is the master page:

ASP.NET
<%@ Master Language="C#" AutoEventWireup="true" 
           CodeFile="MasterPage.master.cs" Inherits="MasterPage" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
         "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>[HelveticSolutions - Masterpage with Localization Support]</title>
</head>

<body>
    <form id="theForm" runat="server">
    <div>
        <asp:contentplaceholder id="ContentPlaceHolder" runat="server">
        </asp:contentplaceholder>
    </div>
    <div style="margin-top:20px;">
        <asp:LinkButton ID="btnSetGerman" runat="server" Text="Deutsch" 
           CommandArgument="de-CH" OnClick="RequestLanguageChange_Click">
        </asp:LinkButton>  
        <asp:LinkButton ID="btnSetEnglish" runat="server" Text="English" 
           CommandArgument="en-GB" OnClick="RequestLanguageChange_Click">
        </asp:LinkButton>
    </div>
    </form>
</body>
</html>

The buttons to change the culture can be either placed in the MasterPage directly, or in any embedded UserControl. In order to determine the requested language, the CommandArgument attribute of the LinkButton is used.

..And the code-behind of the master page:

C#
public partial class MasterPage : System.Web.UI.MasterPage
{
    protected void Page_Load(object sender, EventArgs e)
    {
    }

    protected void RequestLanguageChange_Click(object sender, EventArgs e)
    {
        LinkButton senderLink = sender as LinkButton;

        //store requested language as new culture in the session
        Session["MyCulture"] = senderLink.CommandArgument;

        //reload last requested page with new culture
        Server.Transfer(Request.Path);
    }
}

The requested language, passed within the CommandArgument, is processed and stored in the Session object. Afterwards, the initially requested page will be reloaded on the server side.

Last but not least, the BasePage:

C#
/// <summary>
/// Custom base page used for all web forms.
/// </summary>
public class BasePage : Page
{
    private const string m_DefaultCulture = "en-GB";
    
    protected override void InitializeCulture()
    {
        //retrieve culture information from session
        string culture = Convert.ToString(Session["MyCulture"]);

        //check whether a culture is stored in the session
        if (!string.IsNullOrEmpty(culture)) Culture = culture;
        else Culture = m_DefaultCulture;

        //set culture to current thread
        Thread.CurrentThread.CurrentCulture = CultureInfo.CreateSpecificCulture(culture);
        Thread.CurrentThread.CurrentUICulture = new CultureInfo(culture);

        //call base class
        base.InitializeCulture();
    }
}

As mentioned above, the InitializeCulture method is overridden, and gets the stored culture from the Session object and assigns it to the currently running thread.

Remark: In this article, only the culture was mentioned. Of course, there is also the UI culture. But it is not of any further interest in this article since the handling is absolutely identical. For more information, please see the MSDN pages. :)

For a running example, download the Zip file above.

History

  • 11th May 2007 - First version released.
  • 16th November 2014 - Namespace corrected

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

Michael Ulmann
Architect Swissworx
Australia Australia
MCAD, MCPD Web Developer 2.0, MCPD Enterprise Developer 3.5

My company: Swissworx
My blog: Sitecore Experts

Hopp Schwiiz Smile | :)

Comments and Discussions

 
GeneralRe: Initializing the language automatically [modified] Pin
Vilim_Z10-Sep-09 9:17
MemberVilim_Z10-Sep-09 9:17 
GeneralHot Pin
paulklee5-May-08 17:11
Memberpaulklee5-May-08 17:11 
GeneralRe: Hot Pin
Michael Ulmann15-Nov-14 11:52
MemberMichael Ulmann15-Nov-14 11:52 
GeneralPerfect example for localization Pin
fristi24-Mar-08 4:13
Memberfristi24-Mar-08 4:13 
GeneralRe: Perfect example for localization Pin
Michael Ulmann15-Nov-14 11:52
MemberMichael Ulmann15-Nov-14 11:52 
GeneralGreat, Nice One! Pin
theRexMundi12-Mar-08 2:21
MembertheRexMundi12-Mar-08 2:21 
GeneralRe: Great, Nice One! Pin
Michael Ulmann15-Nov-14 11:53
MemberMichael Ulmann15-Nov-14 11:53 
GeneralMultiple MasterPage or no MasterPage use the global.asax Pin
Jcmorin24-Jan-08 3:48
MemberJcmorin24-Jan-08 3:48 
If you have multiple MasterPage and you don't want the duplicate the code, or if you do not use masterpage at all, you set the thread culture in the global.asax
GeneralExcellent Pin
merlin9819-Nov-07 4:00
professionalmerlin9819-Nov-07 4:00 
GeneralRe: Excellent Pin
Michael Ulmann15-Nov-14 11:53
MemberMichael Ulmann15-Nov-14 11:53 
Generalgood solution for multilanguage website Pin
havan_nd7-Nov-07 17:57
Memberhavan_nd7-Nov-07 17:57 
GeneralRe: good solution for multilanguage website Pin
Michael Ulmann15-Nov-14 11:53
MemberMichael Ulmann15-Nov-14 11:53 
GeneralQuestion about Code (possible bug) Pin
Urs Enzler14-Sep-07 2:04
MemberUrs Enzler14-Sep-07 2:04 
GeneralRe: Question about Code (possible bug) Pin
Michael Ulmann8-Nov-07 7:29
MemberMichael Ulmann8-Nov-07 7:29 
GeneralRe: Question about Code (possible bug) Pin
Urs Enzler8-Nov-07 20:17
MemberUrs Enzler8-Nov-07 20:17 
GeneralPerfect Pin
xiangzi_camel17-Jun-07 21:17
Memberxiangzi_camel17-Jun-07 21:17 
GeneralRe: Perfect Pin
Michael Ulmann15-Nov-14 11:53
MemberMichael Ulmann15-Nov-14 11:53 
GeneralGood article. Pin
phucrobe16-May-07 22:36
Memberphucrobe16-May-07 22:36 
GeneralRe: Good article. Pin
popota7-May-08 8:05
Memberpopota7-May-08 8:05 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.