Master Page Globalization

Introduction

This article explains a page independent way of performing Master Page globalization. Implementation details and complete code snippets are included.

Background

The difficult thing about doing Master Page globalization is that the MasterPage class does not have the InitializeCulture method for us to override. This is significant because the InitializeCulture method is called very early in the page life cycle, and thus is able to affect the initialization of the controls. None of the methods of the MasterPage class can do this. (The best we could do with MasterPage is OnInit, which is not early enough.)

To get around this problem, we have three choices:

1. Override the InitializeCulture method in the pages that use the master page.
2. Set the culture in one of the MasterPage's event handlers and reload the master page to recreate the controls.
3. Set the culture in Global.asax. Global.asax is the first thing called upon page request, and thus provides us with a way to affect control creation.

Because the culture of the current thread resets to default on page redirect and other events, the culture setting process has to take place per request. For this reason, the second solution mentioned above is not acceptable for performance and user experience reasons.

Many articles and forum posts talk about how to implement the first solution. Instead of having InitializeCulture in each page, a more elegant way is to have a base page that handles the culture setting and is inherited by all the pages in the website/web application.

In this article, I would like to talk about the third solution, which allows developers to simply drop a master page to the website/application and make the culture switch work. Implementation details are explained in the following sections.

Setting the Culture in Global.asax

The first task we have here is setting the culture in Global.asax. Cookies are used here because session objects are not accessible in the context when BeginRequest executes.

Global.asax:

protected void Application_BeginRequest(object sender, EventArgs e)
{
     HttpCookie cookie = Request.Cookies["CultureInfo"];

     if (cookie != null && cookie.Value != null)
     {
         Thread.CurrentThread.CurrentUICulture = new CultureInfo(cookie.Value);
         Thread.CurrentThread.CurrentCulture = new CultureInfo(cookie.Value);
     }
    else
    {
        Thread.CurrentThread.CurrentUICulture = new CultureInfo("en-CA");
        Thread.CurrentThread.CurrentCulture = new CultureInfo("en-CA");
    } 
}

The code reads the stored culture information from the cookie and uses it, if it's not null, to set the current thread culture.

Use a Drop Down List to Change the Culture

The next task is to add the drop down list to the master page.

.Master:

<asp:DropDownList ID="ddlLanguage" runat="server" 
       OnSelectedIndexChanged="ddlLanguage_SelectedIndexChanged"
       AutoPostBack="true">
    <asp:ListItem Text="<%$ Resources:Resource, users_English %>" Value="en-CA" />
    <asp:ListItem Text="<%$ Resources:Resource, users_French %>" Value="fr-CA" />
</asp:DropDownList>

Then, we implement the drop down list event handler that stores the selected culture value in the cookie.

.Master.cs:

protected void ddlLanguage_SelectedIndexChanged(object sender, EventArgs e)
{
    //Sets the cookie that is to be used by Global.asax
    HttpCookie cookie = new HttpCookie("CultureInfo");
    cookie.Value = ddlLanguage.SelectedValue;
    Response.Cookies.Add(cookie);

    //Set the culture and reload the page for immediate effect. 
    //Future effects are handled by Global.asax
    Thread.CurrentThread.CurrentCulture = 
                  new CultureInfo(ddlLanguage.SelectedValue);
    Thread.CurrentThread.CurrentUICulture = 
                  new CultureInfo(ddlLanguage.SelectedValue);
    Server.Transfer(Request.Path);
}

As stated in the comments above, setting the culture and performing a reload forces the thread culture to change immediately.

Display the Current Culture in the Drop Down List

Finally, we would like the drop down list to have the current culture as the selected value.

.Master.cs:

protected void Page_Load(object sender, EventArgs e)
{
    //only does it on non-postback because otherwise the selected 
    //value will not reach event handler correctly 
    if (!Page.IsPostBack)
    {
        ddlLanguage.SelectedValue = Thread.CurrentThread.CurrentCulture.Name;
    }
}

Note that it only happens for non-postback events. If we do it for postback events as well, the user selection will be overridden before it reaches the event handler. Another way of getting around this problem is by polling the selected value of the drop down list in Global.asax.

Complete Code Snippets

Global.asax:

protected void Application_BeginRequest(object sender, EventArgs e)
{
     HttpCookie cookie = Request.Cookies["CultureInfo"];

     if (cookie != null && cookie.Value != null)
     {
         Thread.CurrentThread.CurrentUICulture = new CultureInfo(cookie.Value);
         Thread.CurrentThread.CurrentCulture = new CultureInfo(cookie.Value);
     }
    else
    {
        Thread.CurrentThread.CurrentUICulture = new CultureInfo("en-CA");
        Thread.CurrentThread.CurrentCulture = new CultureInfo("en-CA");
    }

}

.Master.cs:

protected void Page_Load(object sender, EventArgs e)
{ 
    //only does it on non-postback because otherwise 
    //the selected value will not reach event handler correctly
    if (!Page.IsPostBack)
	{
        ddlLanguage.SelectedValue = Thread.CurrentThread.CurrentCulture.Name;
    }
}

protected void ddlLanguage_SelectedIndexChanged(object sender, EventArgs e)
{
    //Sets the cookie that is to be used by Global.asax
    HttpCookie cookie = new HttpCookie("CultureInfo");
    cookie.Value = ddlLanguage.SelectedValue;
    Response.Cookies.Add(cookie);

    //Set the culture and reload for immediate effect. 
    //Future effects are handled by Global.asax
    Thread.CurrentThread.CurrentCulture = new CultureInfo(ddlLanguage.SelectedValue);
    Thread.CurrentThread.CurrentUICulture = new CultureInfo(ddlLanguage.SelectedValue);
    Server.Transfer(Request.Path);
}

.Master:

<asp:DropDownList ID="ddlLanguage" runat="server" 
           OnSelectedIndexChanged="ddlLanguage_SelectedIndexChanged"
           AutoPostBack="true">
    <asp:ListItem Text="<%$ Resources:Resource, users_English %>" Value="en-CA" />
    <asp:ListItem Text="<%$ Resources:Resource, users_French %>" Value="fr-CA" /> 
</asp:DropDownList>

History

• March 12, 2009 - Created the article with problem description and code snippets in it.
• March 13, 2009 - Added topic discussion and code description.