Localized UI with XAML files

eirannejad · December 30, 2022, 11:57pm

Related to changes suggested in PR 1645 I have made a few changes to how xaml files are being loaded. These changes allow loading different xaml files for specific languages, or merging localized string dictionaries

Under new method:

If a localized version of a xaml file (e.g. Window.xaml) files exists that would be loaded. For example if user locale is set to Farsi (fa) and Window.fa.xaml exists, that would be loaded as main window.
If a localized resource dictionary xaml file e.g. Window.ResourceDictionary.fa.xaml exist that would be merged into the ResourceDictionary of main xaml file Window.xaml

I have added two unit test buttons for these two methods:

Test XAML (Localized)

Test XAML (Localized Resource)

This is available in WIP installer (added unit tests for two methods or ui localization · eirannejad/pyRevit@73ee4fa · GitHub)

dosymep · January 24, 2023, 4:55pm

How to localize the text that is inside the code?

eirannejad · January 24, 2023, 5:20pm

Kinda up to you at this point. I haven’t figured out an easy way to do that. You can use the xaml resource files as well and reference those from the Window Resources. Maybe we can add a method to read those in a non-ui script as well

dosymep · January 25, 2023, 12:44pm

Can I use get_locale_string from WPFWindow? or this method has been abandoned by mistake?

github.com

eirannejad/pyRevit/blob/develop/pyrevitlib/pyrevit/forms/init.py#L224


      
              return xaml_file
          
          
def merge_resource_dict(self, xaml_source):
              """Reads ResourceDictionary from given xaml file and merged into
              resource dictionary of this window
              """
              lang_dictionary = ResourceDictionary()
              lang_dictionary.Source = Uri(xaml_source, UriKind.Absolute)
              self.Resources.MergedDictionaries.Add(lang_dictionary)
          
          
def get_locale_string(self, string_name):
              return self.FindResource(string_name)
          
          
def setup_owner(self):
              wih = Interop.WindowInteropHelper(self)
              wih.Owner = AdWindows.ComponentManager.ApplicationWindow
          
          
@staticmethod
          def setup_resources(wpf_ctrl):
              #2c3e50
              wpf_ctrl.Resources['pyRevitDarkColor'] = \