Click here to Skip to main content
Click here to Skip to main content

Developing an ASP.NET page with MasterPage and Localization

, 15 Nov 2014 CPOL
Rate this:
Please Sign up or sign in to vote.
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:

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:

<%@ 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:

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:

/// <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. Smile | :)

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 Helvetic Solutions
Australia Australia
MCAD, MCPD Web Developer 2.0, MCPD Enterprise Developer 3.5
 
My company: Helvetic Solutions
My blog: Sitecore Experts
 
Hopp Schwiiz Smile | :)

Comments and Discussions

 
GeneralMy vote of 5 PinmemberHumayun Kabir Mamun16-Nov-14 19:02 
GeneralRe: My vote of 5 PinmemberMichael Ulmann16-Nov-14 19:17 
QuestionNot working when using standard controls of asp.net in default page Pinmembervipz0077-Aug-13 20:30 
QuestionChange sitemap menu language from LocalResources or GlobalResources PinmemberMember 310338317-Apr-13 13:15 
Questionadding Url Rewrite or routing Pinmemberdeching11-Sep-12 1:08 
GeneralThanks Pinmemberrichihu14-Aug-12 3:01 
QuestionWebsite is localized, but how to I put querystrings on them to show different URLs? PinmemberJason P. Weber28-Jan-12 20:36 
QuestionThank you for providing such clear instructions and offering a downloadable source code PinmemberJason P. Weber23-Jan-12 8:13 
QuestionPS - Beautiful implementation PinmemberfitITOren6-Sep-11 5:30 
AnswerRe: PS - Beautiful implementation PinmemberMichael Ulmann15-Nov-14 12:48 
SuggestionWhy session and not cookies?? PinmemberfitITOren6-Sep-11 5:29 
GeneralRe: Why session and not cookies?? PinmemberMichael Ulmann10-Oct-11 18:41 
QuestionSuper great - what about using cookies for remembering for next time...? PinmemberfitITOren6-Sep-11 5:22 
AnswerRe: Super great - what about using cookies for remembering for next time...? PinmemberMichael Ulmann15-Nov-14 12:49 
Questionweb.config PinmemberSuici24-Jun-11 4:47 
AnswerRe: web.config PinmemberMichael Ulmann11-Aug-11 18:19 
GeneralLocalization Page(have issues) PinmemberKleen201113-May-11 11:16 
GeneralRe: Localization Page(have issues) PinmemberMichael Ulmann11-Aug-11 18:23 
GeneralMy vote of 5 PinmemberOmar Gamil26-Dec-10 0:38 
Thanks Michael..been looking for this Wink | ;)
GeneralRe: My vote of 5 PinmemberMichael Ulmann15-Nov-14 12:50 
GeneralMy vote of 5 Pinmemberkimic4-Nov-10 14:59 
GeneralRe: My vote of 5 PinmemberMichael Ulmann15-Nov-14 12:50 
GeneralMy vote of 5 Pinmembergico13-Oct-10 22:09 
GeneralRe: My vote of 5 PinmemberMichael Ulmann15-Nov-14 12:50 
GeneralMy vote of 5 PinmemberKeith Barrow21-Sep-10 9:00 

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

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

| Advertise | Privacy | Terms of Use | Mobile
Web02 | 2.8.141223.1 | Last Updated 15 Nov 2014
Article Copyright 2007 by Michael Ulmann
Everything else Copyright © CodeProject, 1999-2014
Layout: fixed | fluid