Home > Articles > Programming > C#

  • Print
  • + Share This
This chapter is from the book

Making the App World-Ready

At this point, our HelloRealWorld app still only says “hello” to the English-speaking parts of the world. The Windows Store serves hundreds of markets and over a hundred different languages, so ignoring them greatly reduces the audience for your app. Making your app world-ready involves two things: globalization and localization.

Globalization refers to making your app act appropriately for different markets without any changes or customizations. An example of this is formatting the display of currency correctly for the current region without writing special-case logic. The Windows.Globalization namespace contains a lot of functionality for handling dates and times, geographic regions, number formatting, and more. Plus, built-in XAML controls such as DatePicker and TimePicker, discussed in Chapter 15, are globalization-ready. For many apps, these features might not apply.

Localization, which is relevant for practically every app, refers to explicit activity to adapt an app to each new market. The primary example of this is translating text in your user interface to different languages and then displaying the translations when appropriate. Performing this localization activity is the focus of this section.

To make an app ready for localization, you should remove hardcoded English strings that are user-visible, and instead mark such elements with a special identifier unique within the app. Listing 1.6 updates our XAML from Listing 1.2 to do just that.

LISTING 1.6 MainPage.xaml—Markup with User-Visible English Text Removed

<Page
  x:Class="HelloRealWorld.MainPage"
  xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
  xmlns:local="using:HelloRealWorld"
  xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
  xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
  mc:Ignorable="d">
  <Grid Background="{ThemeResource ApplicationPageBackgroundThemeBrush}">
    <StackPanel x:Uid="Panel" Name="stackPanel" Margin="100">
      <TextBlock x:Uid="Greeting" FontSize="80" TextWrapping="WrapWholeWords"
                                                Margin="12,48"/>
      <TextBlock x:Uid="EnterName" FontSize="28" Margin="12"/>
      <Grid>
        <Grid.ColumnDefinitions>
          <ColumnDefinition/>
          <ColumnDefinition Width="Auto"/>
        </Grid.ColumnDefinitions>
        <TextBox Name="nameBox" Margin="12"/>
        <Button x:Uid="GoButton" Grid.Column="1" Click="Button_Click"/>
      </Grid>
      <TextBlock Name="result" FontSize="28" Margin="12"/>
    </StackPanel>
  </Grid>
</Page>

The x:Uid marking is completely independent from an element’s Name. The former is specifically for the localization process, and the latter is for the benefit of code-behind. Note that Listing 1.6 not only removes the three hardcoded strings from the two TextBlocks and the Button, but it also removes the explicit "Blue" color from the StackPanel! This way, we can customize the color for different languages in addition to the text.

With the IDs in place and the text and color for English removed, we need to add them back in a way that identifies them as English-only. To do this, add a new folder to the solution called en. This is the language code for all variations of English. If you want to target the United Kingdom separately, you could add a folder called en-GB. If you want to target Canada separately, you could add a folder called en-CA. And so forth.

Right-click on the en folder and select Add, New Item, then pick Resources file from the General tab. The default name of Resources.resw is fine. This file is a table for all your language-specific strings. Figure 1.10 shows this file populated for English.

FIGURE 1.10

FIGURE 1.10 The Resources.resw file in the en folder is populated with English-specific values.

Each value must be given a name of the form UniqueId.PropertyName. UniqueId must match the x:Uid value for the relevant element, so the Panel.Background entry in Figure 1.10 sets Background to Blue on the StackPanel marked with x:Uid="Panel" in Listing 1.6. From the listing, it’s not obvious that GoButton’s relevant property is called Content, unlike the TextBlocks’ property called Text, but as you learn about the different elements throughout this book, you’ll understand which properties to set.

After filling out the Resources.resw file, you can run the HelloRealWorld app and the result is identical to what we saw earlier in Figures 1.6 and 1.7. However, the app is now ready to be localized for other languages.

We could add additional folders named after language codes and manually populate translated resources with the help of a knowledgeable friend, a professional translator, or translation software. Depending on the current user’s language settings, the appropriate resources are chosen at runtime, with a fallback to the default language if no such resources exist.

However, a better option exists. To take advantage of it, you must download and install the Multilingual App Toolkit from the Windows Dev Center. Once you do this, you can select Enable Multilingual App Toolkit from Visual Studio’s Tools menu. This automatically adds an .xlf file to a new subfolder added to your project called MultilingualResources for a test-only language called Pseudo Language.

We’ll leverage the Pseudo Language in a moment, but first let’s add support for a second real language: Traditional Chinese. To do this, right-click on your project in Solution Explorer and select Add translation languages.... This produces the dialog shown in Figure 1.11.

FIGURE 1.11

FIGURE 1.11 The Multilingual App Toolkit automates the process for supporting new languages.

In this dialog, Pseudo Language and our default English language is already selected, but we can scroll down and select Chinese (Traditional) [zh-Hant] from the list. After pressing OK, the MultilingualResources folder now has two .xlf files: one for Pseudo Language, and one for Traditional Chinese.

Now rebuild the HelloRealWorld app. This populates each .xlf file with a “translation” for each item from the default language .resw file. Initially, each translation is just the duplicated English text. However, for some languages, such as the two we’ve chosen, you can generate machine translations based on the Microsoft Translator service! To do this for the entire file, right-click on each .xlf file and select Generate machine translations. Voilà! Now we’ve got initial translations for all of our resources, which you can see by opening each .xlf file and examining the list inside the multilingual editor. This is shown in Figure 1.12.

FIGURE 1.12

FIGURE 1.12 Each .xlf file contains machine-generated initial translations, courtesy of Microsoft Translator.

Your willingness to trust the results from machine translation is a personal decision, but at least machine translation is a good starting point. (Notice that the generated translations are automatically placed in a “Needs Review” state.) That said, we definitely don’t want the Blue text translated to 01icon01.jpg! This isn’t a user-visible string, and 01icon01.jpg is not a valid value for Background. Instead, let’s “translate” it to Red, which will serve as our language-specific background color. Similarly, we don’t want Blue’s Pseudo Language translation of 033fig02.jpg, so let’s change that to Green.

We have one more change to make. We don’t want “Hello, English-speaking world!” to be translated to Chinese, but rather “Hello, Chinese-speaking world!” Both Microsoft Translator and a colleague tell me that “01icon03.jpg!” is a valid translation, so we can paste that into the appropriate spot of the Chinese .xlf file.

After rebuilding the project, we are now ready to test the localized versions of HelloRealWorld. Just as if we had manually added separate .resw files in per-language folders, the translated resources are used automatically based on the current Windows language settings.

To change the default language used by Windows, you can either use the PC Settings app or the desktop Control Panel. In PC Settings, this can be found under Time & language; Region & language. In Control Panel, it’s under Clock, Language, and Region; Language. Add Chinese (Traditional) and make it the default language to test the Traditional Chinese resources.

To add Pseudo Language (and make it the default language), you have to use a hidden trick in Control Panel. After clicking Add languages, type qps-ploc in the search box for the entry called English (qps-ploc) to appear. You must type the whole thing for this to work! This language is hidden in this way because no normal user should ever enable it.

Figure 1.13 shows the result of running HelloRealWorld when Windows is set to use each of the two non-English languages. These changes are handled completely by the resource-loading mechanism. Other than the switch to marking elements with x:Uid, no code changes were needed. This figure also highlights Pseudo Language’s knack for using really long strings that can highlight potential weaknesses in your app’s layout.

FIGURE 1.13

FIGURE 1.13 HelloRealWorld now acts appropriately for Traditional Chinese and for the test-only Pseudo Language.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020