[Net Core][LOC]The ‘Misc’ component is not translated in local languages OS

[Vino-Wang]

• .NET Core Version: 3.0.100-preview6-012067

• VS: Dev16 16.2 Preview 1 d16.2 28921.214

• OS: CHS RS3 X64

• Affected OS: CHS, CHT, CSY, DEU, ESN, FRA, ITA, JPN, KOR, PTB, RUS, TRK, PLK 13 languages

• Have you experienced this same bug with .NET Framework?: No

Problem description:
The ‘Misc’ component text is not translated in local languages OS.

Actual behavior:
The ‘Msic’ component is not localized in local languages OS.
e.g. CHS

Expected behavior:
The ‘Msic’ should be translated according to the corresponding languages.

Minimal repro:

1. Install latest VS & .NET Core 3.0 on CHS machine, then open the attached app.
   FrameworkApp.zip
   CoreApp.zip
2. Run it and observe the Misc component headers of PropertyGrid.

[lukaschal]

Localized in a xlf file.

File: System.Windows.Forms\src\Resources\xlf\SR.xlf
ID: 0; "PropertyCategoryMisc"
SRC: Misc
TGT: 杂项

https://github.com/dotnet/winforms/blob/master/src/System.Windows.Forms/src/Resources/xlf/SR.zh-Hans.xlf

[RussKie]

I've debugged our code, and it appears we get "Misc" string from .NET Runtime

I run our test app with "ru-RU" locale, and here's what I got as a return from this call for a TextBox control:

Property	Category
AcceptsReturn	Поведение
AutoCompleteMode	Misc
AutoCompleteSource	Misc
AutoCompleteCustomSource	Misc
CharacterCasing	Поведение
Multiline	Поведение
PasswordChar	Поведение
ScrollBars	Внешний вид
Text	Внешний вид
TextAlign	Внешний вид
UseSystemPasswordChar	Поведение
PlaceholderText	Misc
AcceptsTab	Поведение
ShortcutsEnabled	Поведение
BackColor	Внешний вид
BorderStyle	Внешний вид
ForeColor	Внешний вид
HideSelection	Поведение
Lines	Внешний вид
MaxLength	Поведение
ReadOnly	Поведение
WordWrap	Поведение
AccessibleDescription	Специальные возможности
AccessibleName	Специальные возможности
AccessibleRole	Специальные возможности
AllowDrop	Поведение
Anchor	Макет
CausesValidation	Фокус
ContextMenuStrip	Поведение
Cursor	Внешний вид
DataBindings	Данные
Dock	Макет
Enabled	Поведение
Font	Внешний вид
Location	Макет
Margin	Макет
MaximumSize	Макет
MinimumSize	Макет
RightToLeft	Внешний вид
Size	Макет
TabIndex	Поведение
TabStop	Поведение
Tag	Данные
UseWaitCursor	Внешний вид
Visible	Поведение
ImeMode	Поведение

[weltkante]

it appears we get "Misc" string from .NET Runtime

Not really, the .NET Runtime code will look at attributes defined on your classes/properties via reflection or a registered dynamic TypeDescriptorProvider. If the type you are looking at is in your assembly you are still responsible for properly annotating it, even if the data is retrieved through .NET Runtime infrastructure.

From a quick look, the properties in question are missing [SRCategory(...)] attributes. If you meant that the default value for properties not annotated otherwise is coming from .NET Runtime and not being localized, that may be true.

So the question is probably whether you want to push .NET Runtime to localize their default value, or if you just want to annotate all designer visible control properties with SRCategory to ensure they are localized.

[RussKie]

your assembly you are still responsible for properly annotating it

Yes, however it may be a stretch to expect all properties on a given object annotated - one can bind an arbitrary object to a property grid.
Without spending too much time and debugging TypeDescriptor it is hard to tell where "Misc" string comes from, but it doesn't appear come from us in any shape or form.

Further .NET Runtime is not being localised at all (no plans for that either), which is likely what brought us here.

[weltkante]

Further .NET Runtime is not being localised at all

They are localizing exceptions, unless they reverted that decision. It already has been aknowledged that some exceptions are exposed to end users (not just developers) via WinForms and WPF binding and validation systems.

I'd expect this TypeDescriptor situation fall under the same rules, it can end up with the end user if someone places a PropertyGrid in his application, so it should be localized like exception messages.

If it were design-time visible only you could probably argue to override defaults by installing a TypeDescriptorProvider instead of annotating every single property. But for runtime end-user facing behavior its better to fix right at the source since there is literally no situation where you don't want this localized.

[RussKie]

@nakarnam FYI

[elachlan]

So is the fix in runtime and not winforms? Should we move it there? It seems more correct to me, since its the default and if a property is missed when annotating, it will still show as misc.

[elachlan]

CC: @dreddy-work / @merriemcgaw can we move this to runtime or should it stay here in winforms?

[dreddy-work]

runtime should be localized by now. @Olina-Zhang , does this till repro?

[Nora-Zhou01]

Verified on latest 8.0 build .NET 8.0.100-alpha.1.23060.24，the "Msic" component is still not localized in the local language OS, but the location has changed.

[weltkante]

So is the fix in runtime and not winforms?

No, I was saying that the runtime is localizing certain things, and so should WinForms. This is declared in WinForms so it should be localized there.

The question is whether hosting a PropertyGrid for WinForms controls to the end user (not the developer) is still a supported scenario. It was in Desktop Framework but a lot of the designer hosting has been moved outside WinForms into a VS component, so I don't believe its currently reasonable to host a control designer to the end user? (It still is possible to build custom designers, but I'm not sure if its intended to be used with the WinForms controls, or just is left around to be used by 3rd party report designers and the like.)

The team has to comment on their plans in that regard, it may be possible to drop this issue if these properties are no longer designable in hosted designers.

[elachlan]

This is declared in WinForms so it should be localized there.

We already have a translation for it:
https://github.com/dotnet/winforms/blob/a1aa54dff0f6635d3dfb1381aecc0d5d79ed254a/src/System.Windows.Forms/src/Resources/xlf/SR.ru.xlf#L8240-L8244

Which is only used in:
https://github.com/dotnet/winforms/blob/a1aa54dff0f6635d3dfb1381aecc0d5d79ed254a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2ICategorizePropertiesHandler.cs#L14-L32

BUT, if you look at the Attributes we use [SRCategory(nameof(SR.CatBehavior))]. Its using the localization from runtime. As far as I can tell there is no SR.CatMisc.

[elachlan]

I found this in runtime, I am unsure if it is related.

runtime/src/libraries/System.ComponentModel.Primitives/src/System/ComponentModel/CategoryAttribute.cs

Lines 199 to 226 in 76b5b76

	/// <summary>
	/// Looks up the localized name of a given category.
	/// </summary>
	protected virtual string? GetLocalizedString(string value) => value switch
	{
	"Action" => SR.PropertyCategoryAction,
	"Appearance" => SR.PropertyCategoryAppearance,
	"Asynchronous" => SR.PropertyCategoryAsynchronous,
	"Behavior" => SR.PropertyCategoryBehavior,
	"Config" => SR.PropertyCategoryConfig,
	"Data" => SR.PropertyCategoryData,
	"DDE" => SR.PropertyCategoryDDE,
	"Default" => SR.PropertyCategoryDefault,
	"Design" => SR.PropertyCategoryDesign,
	"DragDrop" => SR.PropertyCategoryDragDrop,
	"Focus" => SR.PropertyCategoryFocus,
	"Font" => SR.PropertyCategoryFont,
	"Format" => SR.PropertyCategoryFormat,
	"Key" => SR.PropertyCategoryKey,
	"Layout" => SR.PropertyCategoryLayout,
	"List" => SR.PropertyCategoryList,
	"Mouse" => SR.PropertyCategoryMouse,
	"Position" => SR.PropertyCategoryPosition,
	"Scale" => SR.PropertyCategoryScale,
	"Text" => SR.PropertyCategoryText,
	"WindowStyle" => SR.PropertyCategoryWindowStyle,
	_ => null
	};

[elachlan]

okay, found it.

So the default constructor of CategoryAttribute uses a category value of Default. CategoryAttribute.Category property calls GetLocalizedString which maps Default to SR.PropertyCategoryDefault.

PropertyCategoryDefault is located in Strings.resx:

runtime/src/libraries/System.ComponentModel.Primitives/src/Resources/Strings.resx

Lines 84 to 86 in 76b5b76

	<data name="PropertyCategoryDefault" xml:space="preserve">
	<value>Misc</value>
	</data>

Trying to override it in Winforms does not work and runtime doesn't localize those values as far as I can tell (no xlf folder).

So we would have to ask runtime to localize those values.