Improve Message Box in WinForms

[memoarfaa]

Fixes #12044

Proposed changes

• Style, localize Message Box and add some public API to use custom icon.

Screenshots

Before

After

Test methodology

Manually tested via scratch project.

Microsoft Reviewers: Open in CodeFlow

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 141 lines in your changes missing coverage. Please review.

Project coverage is 76.58368%. Comparing base (72ee6eb) to head (925fc08).
Report is 152 commits behind head on main.

Additional details and impacted files

@@                 Coverage Diff                 @@
##                main      #13440         +/-   ##
===================================================
+ Coverage   75.43847%   76.58368%   +1.14521%     
===================================================
  Files           3230        3230                 
  Lines         639097      639238        +141     
  Branches       47289       47308         +19     
===================================================
+ Hits          482125      489552       +7427     
+ Misses        147952      146112       -1840     
+ Partials        9020        3574       -5446     

Flag	Coverage Δ
Debug	76.58368% <0.00000%> (+1.14521%)	⬆️
integration	18.79525% <0.00000%> (?)
production	50.97896% <0.00000%> (+2.56687%)	⬆️
test	97.40411% <ø> (ø)
unit	48.37502% <0.00000%> (-0.03707%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[KlausLoeffelmann]

Hey guys,

so, I am a bit confused.
In the discussion to the issue, the sentiment seemed to be not taking any changes for the old MessageBox, let alone add new APIs to it.

So, it's not exactly clear to me, what we want to do here.
We cannot change the API of the existing MessageBox, as it would break the world, almost literally.

But we will also not have an additional MessageBox, which would do essentially do the same as the old one. We said that we want the TaskDialog to move forward, and I am looking actively at what options we might have, to have that one adapted to dark mode.

Yes, it's not ideal that we do not have dark mode support for the native MessageBox-es as it is.
And even if we did not touch their APIs - looking at the code, I am not entirely sure, if we want to take the risk of hijacking too many of the API calls (but @JeremyKuhne would have the final saying in this, anyway) as a principal approach.

The only way to get the old MessageBox display acceptable in dark mode would probably be, to completely reimplement it in WinForms based on what we're actually supporting in terms of dark mode support.

That's something I had considered, and I have actually a prototype for testing, and would bring TO a team meeting if time allows during the Preview 6-time frame. But even that is not really likely to make the bar.

We need to discuss internally at the next team meeting, and I will follow up, but I do not see a good chance this being taken.

Klaus

[AraHaan]

Hey guys,

so, I am a bit confused. In the discussion to the issue, the sentiment seemed to be not taking any changes for the old MessageBox, let alone add new APIs to it.

So, it's not exactly clear to me, what we want to do here. We cannot change the API of the existing MessageBox, as it would break the world, almost literally.

But we will also not have an additional MessageBox, which would do essentially do the same as the old one. We said that we want the TaskDialog to move forward, and I am looking actively at what options we might have, to have that one adapted to dark mode.

Yes, it's not ideal that we do not have dark mode support for the native MessageBox-es as it is. And even if we did not touch their APIs - looking at the code, I am not entirely sure, if we want to take the risk of hijacking too many of the API calls (but @JeremyKuhne would have the final saying in this, anyway) as a principal approach.

The only way to get the old MessageBox display acceptable in dark mode would probably be, to completely reimplement it in WinForms based on what we're actually supporting in terms of dark mode support.

That's something I had considered, and I have actually a prototype for testing, and would bring TO a team meeting if time allows during the Preview 6-time frame. But even that is not really likely to make the bar.

We need to discuss internally at the next team meeting, and I will follow up, but I do not see a good chance this being taken.

Klaus

I think installing a hook and uninstalling the hook inside of ShowCore is fine, but allowing one to be able to:

• customize the colors beyond just going into dark mode.
• customize the icon.

Are both beyond the scope of MessageBox.

However, hooking into it's WndProc to override it into dark mode should be alright as long as the person who opened this PR makes it to where that is not part of the public API surface (to ensure existing code does not break) while also allowing dark mode out-of-box when the developer enables dark mode in their application. The reason for this is that I see a way that this can be done as an implementation detail without exposing any new public API's.

[AraHaan]

A few changes I feel can be done. Other than that LGTM. Alternatively the hook step for MessageBox could be split into a separate MessageBox.WndHook.cs file and the hook part from ShowCore into a new method named HookMessageBoxPInvoke basically calling PInvoke.MessageBox right after it hooks the messagebox and inside of it's own try block, and then in the finally block have it unhook it. And then in ShowCore have it call HookMessageBoxPInvoke with no need to cast the result to DialogResult as the HookMessageBoxPInvoke method would cast and return the DialogResult directly.

A benefit to this is then the hook stuff would go into it's own individual file for easier maintainability, but at the cost of making the MessageBox class partial.

[AraHaan]

Alternatively InstallHook could check if if (!Application.IsDarkModeEnabled) and instantly return if dark mode is not enabled to have minimal changes to this method. Same can be done inside of UninstallHook as well.

[AraHaan]

As said below add in this:

Suggested change

	lock (s_lock)
	if (!Application.IsDarkModeEnabled)
	{
	return;
	}
	lock (s_lock)

[AraHaan]

As said below add in this:

Suggested change

	lock (s_lock)
	if (!Application.IsDarkModeEnabled)
	{
	return;
	}
	lock (s_lock)

[AraHaan]

Suggested change

	if (Application.IsDarkModeEnabled)
	{
	InstallHook();
	}
	InstallHook();

[AraHaan]

Suggested change

	if (Application.IsDarkModeEnabled)
	{
	UninstallHook();
	}
	UninstallHook();

[AraHaan]

Suggested change

GetDlgCtrlID

This can be removed as it looks like it is not used.