Convert from Multilingual App Toolkit v3.0 to v4.0 and Fix Error “The Multilingual App Toolkit v4.0 is not compatible with previous versions of the toolkit”

Reason

I used Multilingual App Toolkit 3.0 for my Xamarin application in Visual Studio 2013 in Windows 8.1. Then I moved to a new machine with windows 10 and I installed Visual Studio 2015. Then I opened that Xamarin project in VS 2015 and when I was building the project it gave me an error.

mla error 1

Image 1 : Error

Error

The imported project “C:\Program Files (x86)\MSBuild\Microsoft\Multilingual App Toolkit\Microsoft.Multilingual.ResxResources.targets” was not found.

Confirm that the path in the <Import> declaration is correct, and that the file exists on disk.

Mobility_App.Android

F:\ProjectsBuddhima\mobile\Mobility\Mobility App\Mobility_App.csproj

Reason

Then I searched solutions for the error and according to the error, my new machine has not installed Multilingual App Toolkit.

Solution and Next steps

So I installed Multilingual App Toolkit v.4.0 which is compatible with Visual Studio 2015.

You can download from

https://visualstudiogallery.msdn.microsoft.com/6dab9154-a7e1-46e4-bbfa-18b5e81df520

mla error 2

Image 2 : Download Multilingual App Toolkit v4.0

Then the installer will download to your machine and you have to install it manually.

After I installed Multilingual App toolkit 4.0 I built the project again and I got another error.

Multilingual App Toolkit v4.0 upgrade blocked

The Multilingual App Toolkit v4.0 is not compatible with previous versions of the toolkit

mla error 7

Image 3 : Multilingual app Toolkit is blocked

According to above error message, I browsed the link in the http://aka.ms/mat4faq

According to their technical references I will describe steps to convert from v3 to v4.

  1. First take a backup of existing project.
  2. Then we have to open the project which has Multilingual App toolkit v3.
  3. Then we have to disable app toolkit for projects. Go to tools and click “Disable Multilingual App Toolkit”.

    1 disable MLA tool kit

    Image 4 : Disable MLA Toolkit

  4. Then Copy current .xlf files to another location as a backup and delete all .xlf files in the project.

    2 remove xlf files

    Image 5 : Remove current XLF files

  5. Then rebuild the project.

 

Sometimes these steps are not enough to fully disable toe Multilingual App toolkit. So we have to disable it using config file manually.

Here are steps to remove them manually.

1.Right click the config file in the project and open it.
2.Search the label “MultilingualAppToolkit” in the config file.

12 multi languala app label

Image 6 : Delete property group from config file

3.Then delete above <PropertyGroup> which contains <MultilingualAppToolkitVirsion> tag.
4.Then we have to search again “MultilingualAppToolkit” label. And you will see <import> element.

13 delete multi languala import label

Image 7 : Delete <import> tag which contains MLA label

And also we have to delete the <Import> tag which contains “MultilingualAppToolkit”.

 

5.Then rebuild the project.

Now we have removed configurations of Multilingual App Toolkit from our project and we are ready to add v4.0 configurations.

Then we have to enable Multilingual App Toolkit from Toolbox.

1 Enable mltk

Image 8 : Enable MLA Toolkit

When we enable the Multilingual App Toolkit v4.0, we are ready to recycle Transitions from v3.0 project’s .xlf files.

Below I have added steps for that.

1.  Please check that the Multilingual App Toolkit v4.0 is enabled.

2. Then click on the project and select Multilingual App Toolkit=> Add transition languages

3 add multilangual languages

Image 9 : Multilingual App Toolkit ->  Add Transition languages

3. We can see language list in a window like below. Select languages that previously we have added to the project.

4 select languages

Image 10 : Select Languages

When click “OK”. New xlf files will be added to our project in a folder called “MultilingualResources”.  Below image shows it.

5 added xlf files

Image 11 : Added XLF files for selected languages

4. Then click on “MultilingualAppResources” folder and click .. Multilingual App Toolkit=> Import / recycling translations

6 import recycling transactions

Image 12 : Multilingual App Toolkit -> Import/Recycle Transitions

Then you will see below window.

7 import recycling transactions

Image 13 : Import Transition window

5. Click “Add button” and then select v3 xlf files from the location that we have copied from previous project.

8 select old v3 files

Image 14 : Select and Add  XML files in v3 project.

6. Then Select xlf files that we copied from the temporary location and Click “Open”. Then selected xlf files will be added to import resources form.

9 seletec xlf v3 files

Image 15 : Added XLF files

7. And an Important thing is we have to check the “Enable resource recycling” check box. And then click the import button.

10 enable recycling and import

Image 16 : Enable resource recycling and Import

8. Then rebuild the project.

11 success

Image 17 : Successfully Built project

Then we can see those .xlf files has been added to project and the project has built successfully.

Thank you !

Add Attributes to Resource(.resx) file from Excel file in C#

SUBJECT…

Today I’m going to create a windows form app to write items to application resource (.resx) file using data in a excel file.

REASON…

The reason I decided to develop this kind of app is, I’m working on a Xamarin project and it supports for English, French and Dutch. So I had to add translations for both two languages for English.

In Visual Studio we can Add Recourse key and value attributes manually using resx file. I’ll show you how we can do it manually.

3 add attributes manually 3

Image 1 : Add attributes manually to Resource file

What I had to do is copy Name and keys from above excel file and paste in to Name field and Key field one by one.

But it is not easy when there are thousands of Names and translations (keys). Because it’ll waste time.

MY SOLUTION…

So I decided to develop a small app to write resource attributes using a excel file to resx files.

I have two resource files for French and Dutch and you can see them under project resource folder in below image.

2 project style

Image 2 : Application design and class structure

Then I created a small windows form with two buttons for French and Dutch and a List view.

Now I’ll describe the coding part for above functionality.

First I have added resource file paths as attributes to App.config file.


<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <startup>
        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5" />
    </startup>
  <appSettings>
    <add key="resPathFr" value="F:\My softwares\Excel to RESX\TranslationMobile\Translation\Properties\AppResources.fr.resx"/>
    <add key="resPathNl" value="F:\My softwares\Excel to RESX\TranslationMobile\Translation\Properties\AppResources.nl.resx"/>
  </appSettings>
</configuration>

Then Add the Excel file “Book1.xlsx” to Startup path  “//bin”.

Here is the format of the excel file I’m going to use..

1 Excel file

Image 3 : The Excel file which contains Translations

According to this excel file, Keys are in “ID” column which is column “A”. And English definitions are in column “B”, French/FR definitions are in column “D” and Dutch/NL definitions are in column “F”.

And These keys and definitions are stored in “Sheet1”.

Then I will add useful namespaces that we have to use in Form1.cs class additionally to default namespaces .


using System.Linq;
using Excel = Microsoft.Office.Interop.Excel;
using System.Resources;
using System.Configuration;

We have to Add Office.Interop.Excel namespace from references like below image

4 add excel namespace

Image 4 : import Excel resource from references

Then I’ll add another class called “ResourcesFr” with two property to store Key, Value collection. But you can use a Dictionary<string,string> instead of using a Generic collection to store Keys and Values. Because we are using only two properties to store data.


public class ResourcesFr
 {
 public string Key { get; set; }
 public string Value { get; set; }
 }

Then we can start coding in Form1.

I’ll add five properties in Form one for Excel Application,Workbook, Sheet, Key/value list and another one for missing values.


namespace Translation
{
 public partial class Form1 : Form
 {
 public Form1()
 {
 InitializeComponent();
 }

List<ResourcesFr> keyList = new List<ResourcesFr>();

Excel.Application xlApp;
 Excel.Workbook xlWorkBook;
 Excel.Worksheet xlWorkSheet;
 object misValue = System.Reflection.Missing.Value;

}

}

Then Double Click the “Dutch button” in the Form1 and it’ll create a Button_Click event.


private void btnDutch_Click(object sender, EventArgs e)
{

}

In this event we can add code for read the excel file and populate key,value information to the keyList property that we declared in the top of the Form1 class.


        ///<summary>
        /// Add Dutch Translations
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void btnDutch_Click(object sender, EventArgs e)
        {
            xlApp = new Excel.Application();
            // path of the Excel file
            string path = (Application.StartupPath + "\\Book1.xlsx");
            // Get Excel file to  xlWorkBook property
            xlWorkBook = xlApp.Workbooks.Open(path);
            // Get "Sheet1" as xlWorkSheet : you can see it in excel sheet image
            xlWorkSheet = (Excel.Worksheet)xlWorkBook.Worksheets.get_Item(1);

            // In the excel sheet we have 322 rows, So I added go through the loop untill 322
            for (int i = 1; i < 322; i++)
            {
                ResourcesFr fr = new ResourcesFr();
                string s = "";
                string s2 = "";
                s = string.Format("A"); // The Key(ID) is in Column A
                s2 = string.Format("F"); // The Value(Text (NL)) is in Column F
                if (xlWorkSheet.Cells[i, s].Value != null)
                {
                    // Get Key
                    fr.Key = xlWorkSheet.Cells[i, s].Value.ToString();
                    //Get Value
                    fr.Value = (xlWorkSheet.Cells[i, s2].Value != null) ? xlWorkSheet.Cells[i, s2].Value.ToString() : "";
                    // Add Key and Value to List<ResourcesFr> keyList
                    keyList.Add(fr);
                }
            }
            // CLose the Excel workbook
            xlWorkBook.Close(true, misValue, misValue);
            // Exit form Excel
            xlApp.Quit();

            // Clean the memory
            ReleaseObject(xlWorkSheet);
            ReleaseObject(xlWorkBook);
            ReleaseObject(xlApp);

            AddMemoLine("Dutch");
            int c = 0;
            foreach (var f in keyList)
            {
                // Insert or Update values
                AddOrUpdateResource(f.Key, f.Value, "NL");
                c++;
                // write in List view
                AddMemoLine(string.Format("Key : {0},       Value : {1}", f.Key, f.Value));
            }
            MessageBox.Show("Dutch resx properties has updated");
        }

ReleaseObject() Method does clean the Garbage collection and get the unused memory.


private void ReleaseObject(object obj)
{
try
{
System.Runtime.InteropServices.Marshal.ReleaseComObject(obj);
obj = null;
}
catch (Exception ex)
{
obj = null;
MessageBox.Show(&quot;Unable to release the Object &quot; + ex.ToString());
}
finally
{
GC.Collect();
}
}

AddOrUpdate() Method does Insert new record to resource file if it is not existing or update the existing record if it is existing.


        ///
<summary>
        /// update resource file
        /// </summary>

        /// <param name="key"></param>
        /// <param name="value"></param>
        /// <param name="lang"></param>
        public void AddOrUpdateResource(string key, string value, string lang)
        {
            try
            {
                // Get Resource File Path
                string resPath = string.Empty;
                if (lang == "FR")
                {
                    resPath = ConfigurationManager.AppSettings["resPathFr"];
                }
                else if (lang == "NL")
                {
                    resPath = ConfigurationManager.AppSettings["resPathNl"];
                }
                else { }
                if (!string.IsNullOrWhiteSpace(resPath))
                {
                    var resx = new List<DictionaryEntry>();
                    using (var reader = new ResXResourceReader(resPath))
                    {
                        resx = reader.Cast<DictionaryEntry>().ToList();

                        // Check if the key is existing
                        var existingResource = resx.Where(r => r.Key.ToString() == key).FirstOrDefault();

                        // Insert new Record if the key is not existing
                        if (existingResource.Key == null && existingResource.Value == null) // NEW!
                        {
                            resx.Add(new DictionaryEntry() { Key = key, Value = value });
                        }
                        else // MODIFIED RESOURCE!
                        {
                            var modifiedResx = new DictionaryEntry() { Key = existingResource.Key, Value = value };
                            resx.Remove(existingResource);  // REMOVING RESOURCE!
                            resx.Add(modifiedResx);  // AND THEN ADDING RESOURCE!
                        }
                    }

                    // Write resources to resx file
                    using (var writer = new ResXResourceWriter(resPath))
                    {
                        resx.ForEach(r =>
                        {
                       // Again Adding all resource to generate with final items
                       writer.AddResource(r.Key.ToString(), r.Value.ToString());
                        });
                        writer.Generate();
                    }
                }

            }
            catch (Exception ex)
            {
                AddMemoLine(string.Format("Key : {0},  Value : {1},  Lang{2}  Throws an error {3}  ", key,value, lang,ex.Message));
            }
        }

And MemoLine() Method does insert an  item to list view.. Then user can see what is happening now..


        ///
<summary>
        /// Insert a record to List view..
        /// </summary>

        /// <param name="data"></param>
        private void AddMemoLine(string data)
        {
            txtResultList.AppendText(data);
            txtResultList.AppendText(Environment.NewLine);
        }

Then run the program and Click the “Dutch” button and you will see update/Inserted records in few seconds.

5 final result

Image 5 : Adding Attributes to resource file

Then close the program and Open the resource file Resource.nl.resx and you will see all records in the excel sheet has transferred to the resx file.

6 resx resource file updated

Added attributes to Resources.nl.resx

You can do the Same thing to “French button”. And You can download the full project using below link.

Download the project file

Thanks !

Buddhima Kudagama

kgbuddhima@gmail.com