Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

WinUI like Resource Management and Localization #225

Merged
merged 4 commits into from
Mar 9, 2021
Merged

WinUI like Resource Management and Localization #225

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
00c0103
Added automation tool to convert RESW files to RESX files
ShankarBUS Nov 17, 2020
485b78f
Updated Resource Management for most controls
ShankarBUS Dec 7, 2020
ea57673
Completed ResourceManagement
ShankarBUS Jan 5, 2021
bc762c3
loc update (microsoft/microsoft-ui-xaml#3878)
ShankarBUS Jan 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
20 changes: 20 additions & 0 deletions ModernWpf.Controls/Common/ResourceHelper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
namespace ModernWpf.Controls
{
internal static class ResourceHelper
{
/// <summary>
/// This method must be called from every control/class's constructor (<see langword="static"/> or default)
/// present in the <strong>ModernWpf.Controls</strong> assembly
/// that makes use of the <see cref="ResourceAccessor.GetLocalizedStringResource(string)"/> method.
/// </summary>
/// <remarks>
/// This method ensures that the <see cref="ResourceAccessor"/> is aware of this (<strong>ModernWpf.Controls</strong>) assembly.
/// We use this method instead of using the <see cref="System.Reflection.Assembly.GetCallingAssembly"/> method
/// because it is unreliable and may cause instabilities in the end application.
/// </remarks>
public static void Initialize()
{
ResourceAccessor.modernWpfControlsAssembly ??= typeof(ResourceHelper).Assembly;
}
}
}
2 changes: 1 addition & 1 deletion ModernWpf.Controls/ModernWpf.Controls.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<TargetsForTfmSpecificBuildOutput>$(TargetsForTfmSpecificBuildOutput);GetDocumentationFile</TargetsForTfmSpecificBuildOutput>
<NuspecFile>$(MSBuildThisFileDirectory)ModernWpfUI.nuspec</NuspecFile>
<PackageId>ModernWpfUI</PackageId>
<LangVersion>8.0</LangVersion>
<LangVersion>latest</LangVersion>
</PropertyGroup>

<ItemGroup>
Expand Down
26 changes: 14 additions & 12 deletions ModernWpf.Controls/NavigationView/NavigationView.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
using ModernWpf.Input;
using ModernWpf.Media.Animation;
using static CppWinRTHelpers;
using static ModernWpf.ResourceAccessor;

namespace ModernWpf.Controls
{
Expand Down Expand Up @@ -213,6 +214,7 @@ void UnhookEventsAndClearFields(bool isFromDestructor = false)

static NavigationView()
{
ResourceHelper.Initialize();
DefaultStyleKeyProperty.OverrideMetadata(typeof(NavigationView), new FrameworkPropertyMetadata(typeof(NavigationView)));
}

Expand Down Expand Up @@ -546,8 +548,8 @@ public override void OnApplyTemplate()
if (GetTemplateChild(c_topNavOverflowButton) is Button topNavOverflowButton)
{
m_topNavOverflowButton = topNavOverflowButton;
AutomationProperties.SetName(topNavOverflowButton, Strings.NavigationOverflowButtonName);
topNavOverflowButton.Content = Strings.NavigationOverflowButtonText;
AutomationProperties.SetName(topNavOverflowButton, ResourceAccessor.GetLocalizedStringResource(SR_NavigationOverflowButtonName));
topNavOverflowButton.Content = ResourceAccessor.GetLocalizedStringResource(SR_NavigationOverflowButtonText);
// TODO: WPF - Header Animation
/*
auto visual = winrt::ElementCompositionPreview::GetElementVisual(topNavOverflowButton);
Expand All @@ -558,7 +560,7 @@ public override void OnApplyTemplate()
if (toolTip is null)
{
var tooltip = new ToolTip();
tooltip.Content = Strings.NavigationOverflowButtonToolTip;
tooltip.Content = ResourceAccessor.GetLocalizedStringResource(SR_NavigationOverflowButtonToolTip);
ToolTipService.SetToolTip(topNavOverflowButton, tooltip);
}

Expand Down Expand Up @@ -650,7 +652,7 @@ public override void OnApplyTemplate()
m_paneSearchButton = button;
button.Click += OnPaneSearchButtonClick;

var searchButtonName = Strings.NavigationViewSearchButtonName;
var searchButtonName = ResourceAccessor.GetLocalizedStringResource(SR_NavigationViewSearchButtonName);
AutomationProperties.SetName(button, searchButtonName);
var toolTip = new ToolTip();
toolTip.Content = searchButtonName;
Expand All @@ -662,7 +664,7 @@ public override void OnApplyTemplate()
m_backButton = backButton;
backButton.Click += OnBackButtonClicked;

string navigationName = Strings.NavigationBackButtonName;
string navigationName = ResourceAccessor.GetLocalizedStringResource(SR_NavigationBackButtonName);
AutomationProperties.SetName(backButton, navigationName);

WindowChrome.SetIsHitTestVisibleInChrome(backButton, true);
Expand All @@ -684,7 +686,7 @@ public override void OnApplyTemplate()

if (GetTemplateChild(c_navViewBackButtonToolTip) is ToolTip backButtonToolTip)
{
string navigationBackButtonToolTip = Strings.NavigationBackButtonToolTip;
string navigationBackButtonToolTip = ResourceAccessor.GetLocalizedStringResource(SR_NavigationBackButtonToolTip);
backButtonToolTip.Content = navigationBackButtonToolTip;
}

Expand All @@ -693,15 +695,15 @@ public override void OnApplyTemplate()
m_closeButton = closeButton;
closeButton.Click += OnPaneToggleButtonClick;

string navigationName = Strings.NavigationCloseButtonName;
string navigationName = ResourceAccessor.GetLocalizedStringResource(SR_NavigationCloseButtonName);
AutomationProperties.SetName(closeButton, navigationName);

WindowChrome.SetIsHitTestVisibleInChrome(closeButton, true);
}

if (GetTemplateChild(c_navViewCloseButtonToolTip) is ToolTip closeButtonToolTip)
{
string navigationCloseButtonToolTip = Strings.NavigationButtonOpenName;
string navigationCloseButtonToolTip = ResourceAccessor.GetLocalizedStringResource(SR_NavigationButtonOpenName);
closeButtonToolTip.Content = navigationCloseButtonToolTip;
}

Expand Down Expand Up @@ -1380,7 +1382,7 @@ void CreateAndHookEventsToSettings()
settingsItem.Icon = settingsIcon;

// Do localization for settings item label and Automation Name
var localizedSettingsName = Strings.SettingsButtonName;
var localizedSettingsName = ResourceAccessor.GetLocalizedStringResource(SR_SettingsButtonName);
AutomationProperties.SetName(settingsItem, localizedSettingsName);
settingsItem.Tag = localizedSettingsName;
UpdateSettingsItemToolTip();
Expand Down Expand Up @@ -1952,11 +1954,11 @@ void SetPaneToggleButtonAutomationName()
string navigationName;
if (IsPaneOpen)
{
navigationName = Strings.NavigationButtonOpenName;
navigationName = ResourceAccessor.GetLocalizedStringResource(SR_NavigationButtonOpenName);
}
else
{
navigationName = Strings.NavigationButtonClosedName;
navigationName = ResourceAccessor.GetLocalizedStringResource(SR_NavigationButtonClosedName);
}

if (m_paneToggleButton is { } paneToggleButton)
Expand All @@ -1978,7 +1980,7 @@ void UpdateSettingsItemToolTip()
}
else
{
var localizedSettingsName = Strings.SettingsButtonName;
var localizedSettingsName = ResourceAccessor.GetLocalizedStringResource(SR_SettingsButtonName);
var toolTip = new ToolTip();
toolTip.Content = localizedSettingsName;
ToolTipService.SetToolTip(settingsItem, toolTip);
Expand Down
4 changes: 3 additions & 1 deletion ModernWpf.Controls/NavigationView/NavigationViewItemAutomationPeer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
using System.Windows.Automation.Peers;
using System.Windows.Automation.Provider;
using ModernWpf.Controls;
using static ModernWpf.ResourceAccessor;

namespace ModernWpf.Automation.Peers
{
Expand All @@ -18,6 +19,7 @@ public class NavigationViewItemAutomationPeer :
public NavigationViewItemAutomationPeer(NavigationViewItem owner) :
base(owner)
{
ResourceHelper.Initialize();
}

protected override string GetNameCore()
Expand All @@ -38,7 +40,7 @@ protected override string GetNameCore()
// NB: It'll be up to the app to determine the automation label for
// when they're using a PlaceholderValue vs. Value.

returnHString = Strings.NavigationViewItemDefaultControlName;
returnHString = ResourceAccessor.GetLocalizedStringResource(SR_NavigationViewItemDefaultControlName);
}

return returnHString;
Expand Down
164 changes: 164 additions & 0 deletions ModernWpf.Controls/NavigationView/Strings/Resources.af-ZA.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,164 @@
<?xml version="1.0" encoding="utf-8"?>
<root>
<!--
Microsoft ResX Schema

Version 2.0

The primary goals of this format is to allow a simple XML format
that is mostly human readable. The generation and parsing of the
various data types are done through the TypeConverter classes
associated with the data types.

Example:

... ado.net/XML headers & schema ...
<resheader name="resmimetype">text/microsoft-resx</resheader>
<resheader name="version">2.0</resheader>
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
<value>[base64 mime encoded serialized .NET Framework object]</value>
</data>
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
<comment>This is a comment</comment>
</data>

There are any number of "resheader" rows that contain simple
name/value pairs.

Each data row contains a name, and value. The row also contains a
type or mimetype. Type corresponds to a .NET class that support
text/value conversion through the TypeConverter architecture.
Classes that don't support this are serialized and stored with the
mimetype set.

The mimetype is used for serialized objects, and tells the
ResXResourceReader how to depersist the object. This is currently not
extensible. For a given mimetype the value must be set accordingly:

Note - application/x-microsoft.net.object.binary.base64 is the format
that the ResXResourceWriter will generate, however the reader can
read any of the formats listed below.

mimetype: application/x-microsoft.net.object.binary.base64
value : The object must be serialized with
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
: and then encoded with base64 encoding.

mimetype: application/x-microsoft.net.object.soap.base64
value : The object must be serialized with
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
: and then encoded with base64 encoding.

mimetype: application/x-microsoft.net.object.bytearray.base64
value : The object must be serialized into a byte array
: using a System.ComponentModel.TypeConverter
: and then encoded with base64 encoding.
-->
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
<xsd:element name="root" msdata:IsDataSet="true">
<xsd:complexType>
<xsd:choice maxOccurs="unbounded">
<xsd:element name="metadata">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" />
</xsd:sequence>
<xsd:attribute name="name" use="required" type="xsd:string" />
<xsd:attribute name="type" type="xsd:string" />
<xsd:attribute name="mimetype" type="xsd:string" />
<xsd:attribute ref="xml:space" />
</xsd:complexType>
</xsd:element>
<xsd:element name="assembly">
<xsd:complexType>
<xsd:attribute name="alias" type="xsd:string" />
<xsd:attribute name="name" type="xsd:string" />
</xsd:complexType>
</xsd:element>
<xsd:element name="data">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
<xsd:attribute ref="xml:space" />
</xsd:complexType>
</xsd:element>
<xsd:element name="resheader">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required" />
</xsd:complexType>
</xsd:element>
</xsd:choice>
</xsd:complexType>
</xsd:element>
</xsd:schema>
<resheader name="resmimetype">
<value>text/microsoft-resx</value>
</resheader>
<resheader name="version">
<value>2.0</value>
</resheader>
<resheader name="reader">
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<resheader name="writer">
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<data name="NavigationButtonClosedName" xml:space="preserve">
<value>Maak navigasie oop</value>
<comment>Automation name for the hamburger button when it is in a closed state</comment>
</data>
<data name="NavigationButtonOpenName" xml:space="preserve">
<value>Sluit navigasie</value>
<comment>Automation name and tooltip caption for the hamburger button when it is in an open state, and tooltip caption for the close button</comment>
</data>
<data name="NavigationViewItemDefaultControlName" xml:space="preserve">
<value>NavigationViewItem</value>
<comment>Default automation id if no name or id is provided</comment>
</data>
<data name="SettingsButtonName" xml:space="preserve">
<value>Instellings</value>
<comment>Automation name for the settings button</comment>
</data>
<data name="NavigationViewSearchButtonName" xml:space="preserve">
<value>Klik om te soek</value>
<comment>Name for the compact view search button</comment>
</data>
<data name="NavigationBackButtonName" xml:space="preserve">
<value>Terug</value>
<comment>Automation name for the nav view provided back button</comment>
</data>
<data name="NavigationBackButtonToolTip" xml:space="preserve">
<value>Terug</value>
<comment>ToolTip caption for the back button</comment>
</data>
<data name="NavigationCloseButtonName" xml:space="preserve">
<value>Sluit</value>
<comment>Automation name for the nav view provided close button</comment>
</data>
<data name="NavigationOverflowButtonName" xml:space="preserve">
<value>Meer</value>
<comment>Automation name for the nav view more button when panel is on top</comment>
</data>
<data name="NavigationOverflowButtonText" xml:space="preserve">
<value>Meer</value>
<comment>Text for the nav view more button when panel is on top</comment>
</data>
<data name="NavigationOverflowButtonToolTip" xml:space="preserve">
<value>Meer</value>
<comment>ToolTip caption for the nav view more button when panel is on top</comment>
</data>
</root>
Loading