Add Dark Mode Visual Style Theme Subclass #11985

memoarfaa · 2024-08-25T17:48:31Z

This is an improvement to new Dark Mode experimental feature
#11857
see
https://learn.microsoft.com/en-us/windows/win32/controls/theme-subclasses#two-ways-to-use-a-theme-subclass

Fixes #11893.
Fixes #11953.

Microsoft Reviewers: Open in CodeFlow

…pport.

… DataGridView

…orted Windows Registry Key may be deleted and never restored and may be exist and there is no dark mode subclass in aero.msstyles

memoarfaa · 2024-08-25T18:48:20Z

@dotnet-policy-service agree في الأحد، ٢٥ أغسطس ٢٠٢٤ ٨:٤٩ م dotnet-policy-service[bot] < ***@***.***> كتب: (Translation: on Sun، 25 August 2024 8:49 PM dotnet-policy-service[bot] < ***@***.***> wrote:)

…

Assigned #11985 <#11985> to @memoarfaa <https://github.com/memoarfaa>. — Reply to this email directly, view it on GitHub <#11985 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AC7KK2CGY675YZFK4S663ZDZTIKK5AVCNFSM6AAAAABNCXIQDKVHI2DSMVQWIX3LMV45UABCJFZXG5LFIV3GK3TUJZXXI2LGNFRWC5DJN5XDWMJUGAYDIOJSGYYTAOI> . You are receiving this because you were assigned.Message ID: ***@***.***>

...tem.Windows.Forms/src/System/Windows/Forms/Controls/DataGridView/DataGridViewCheckBoxCell.cs

src/System.Windows.Forms/src/System/Windows/Forms/Controls/ComboBox/ComboBoxRenderer.cs

RussKie · 2024-08-26T03:15:08Z

...ystem.Windows.Forms/src/System/Windows/Forms/Controls/DataGridView/DataGridViewButtonCell.cs

@@ -17,7 +17,11 @@ public partial class DataGridViewButtonCell : DataGridViewCell
    private static readonly int s_propButtonCellFlatStyle = PropertyStore.CreateKey();
    private static readonly int s_propButtonCellState = PropertyStore.CreateKey();
    private static readonly int s_propButtonCellUseColumnTextForButtonValue = PropertyStore.CreateKey();
-    private static readonly VisualStyleElement s_buttonElement = VisualStyleElement.Button.PushButton.Normal;
+#pragma warning disable WFO5001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
+    private static readonly VisualStyleElement s_darkButtonElement = VisualStyleElement.CreateElement("DarkMode_Explorer::BUTTON", 1, 1);


I think, instead of hardcoding "DarkMode_Explorer" it should be an interpolated const, e.g.: {DarkModeIdentifier}_{Explorer}.
See:

winforms/src/System.Windows.Forms/src/System/Windows/Forms/Control.cs

Lines 162 to 165 in 14acefa

internal const string DarkModeIdentifier = "DarkMode";

internal const string ExplorerThemeIdentifier = "Explorer";

internal const string ItemsViewThemeIdentifier = "ItemsView";

internal const string ComboBoxButtonThemeIdentifier = "CFD";

If any more consts need adding - they should be added here.

Done, does that look good now?

Actually, I do not see that you changed anything.
Can you make the changes?

src/System.Windows.Forms/src/System/Windows/Forms/Controls/TabControl/TabRenderer.cs

src/System.Windows.Forms/src/System/Windows/Forms/VisualStyles/VisualStyleRenderer.cs

RussKie · 2024-08-26T03:21:18Z

@KlausLoeffelmann @JeremyKuhne @merriemcgaw @lonitra - if this fixes the rendering issue, this change would be a great addition to the .NET 9 release.

AraHaan · 2024-08-26T06:10:48Z

As long as I can use the new API to set color mode on my entire application from my settings form at runtime at any time to switch between light and dark mode I would be happy in the .NET 9 release.

Also what about all of the system menus in all the possible controls as well? Are they dark themed with this change now or do I have to go into black magic to convert them to ContextMenuStrips that I set then a custom dark theme renderer to that is not rounded. Yes, I feel like an easier way of doing this is inside of Winforms would be a good idea (where winforms converts them to a ContextMenuStrip that auto themes it to light or dark) for the application and to a global setting for if they want all ContextMenuStrips to be rounded or not would make me happy as well but that can come in .NET 10 on that change.

src/System.Windows.Forms/src/System/Windows/Forms/VisualStyles/VisualStyleRenderer.cs

KlausLoeffelmann · 2024-08-26T20:04:48Z

src/System.Windows.Forms/src/System/Windows/Forms/Application.cs

@@ -379,21 +377,9 @@ private static int GetSystemColorModeInternal()
            return SystemDarkModeDisabled;
        }

-        int systemColorMode = SystemDarkModeDisabled;


We're still discussing, if we can take this for .NET 9 RC2 (the bar is service, and we would need to consider this a bug fix). So, this particular change, we would probably not want to take. @merriemcgaw, @lonitra.

This needs to be as it is, please revert this.

lonitra

Could you please also update the description to provide a visual of the before/after of this change?

src/System.Windows.Forms/src/System/Windows/Forms/VisualStyles/VisualStyleRenderer.cs

…/VisualStyleRenderer.cs Co-authored-by: Loni Tra <[email protected]>

codecov · 2024-09-03T21:56:05Z

Codecov Report

Attention: Patch coverage is 25.80645% with 46 lines in your changes missing coverage. Please review.

Project coverage is 75.06842%. Comparing base (8cdb3e0) to head (2ac8c87).
Report is 8 commits behind head on main.

Additional details and impacted files

@@                 Coverage Diff                 @@
##                main      #11985         +/-   ##
===================================================
+ Coverage   75.03366%   75.06842%   +0.03476%     
===================================================
  Files           3063        3063                 
  Lines         632075      632114         +39     
  Branches       46784       46800         +16     
===================================================
+ Hits          474269      474518        +249     
+ Misses        154431      154218        -213     
- Partials        3375        3378          +3

Flag	Coverage Δ
Debug	`75.06842% <25.80645%> (+0.03476%)`	⬆️
integration	`17.94234% <16.12903%> (+0.08534%)`	⬆️
production	`48.22065% <25.80645%> (+0.08131%)`	⬆️
test	`97.01607% <ø> (-0.00029%)`	⬇️
unit	`45.24617% <22.58065%> (-0.00481%)`	⬇️

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

…Control/TabRenderer.cs Co-authored-by: Igor Velikorossov <[email protected]>

into Feature/DarkMode

lonitra · 2024-09-04T21:23:54Z

...ystem.Windows.Forms/src/System/Windows/Forms/Controls/DataGridView/DataGridViewButtonCell.cs

@@ -17,7 +17,11 @@ public partial class DataGridViewButtonCell : DataGridViewCell
    private static readonly int s_propButtonCellFlatStyle = PropertyStore.CreateKey();
    private static readonly int s_propButtonCellState = PropertyStore.CreateKey();
    private static readonly int s_propButtonCellUseColumnTextForButtonValue = PropertyStore.CreateKey();
-    private static readonly VisualStyleElement s_buttonElement = VisualStyleElement.Button.PushButton.Normal;
+#pragma warning disable WFO5001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
+    private static readonly VisualStyleElement s_darkButtonElement = VisualStyleElement.CreateElement("DarkMode_Explorer::BUTTON", 1, 1);


I believe this was missed

Suggested change

private static readonly VisualStyleElement s_darkButtonElement = VisualStyleElement.CreateElement("DarkMode_Explorer::BUTTON", 1, 1);

private static readonly VisualStyleElement s_darkButtonElement = VisualStyleElement.CreateElement($"{Control.DarkModeIdentifier}_{Control.ExplorerThemeIdentifier}::BUTTON", 1, 1);

lonitra · 2024-09-04T21:43:38Z

src/System.Windows.Forms/src/System/Windows/Forms/VisualStyles/VisualStyleRenderer.cs

+    /// <summary>
+    /// <para>
+    /// Gets a value specifying whether the operating system has Dark Mode visual styles subclass and the Application can  use this subclass to draw controls with Dark Mode theme.
+    ///</para>
+    ///<para>
+    ///<return>
+    ///<para> Returns true if Visual Style Dark Mode subclass is: </para>
+    /// <para> 1) Supported by the operating system.</para>
+    /// <para> 2) Enabled in the client area.</para>
+    /// <para> 3) operating system not ruining in high contrast mode</para>
+    /// <para> Otherwise, returns false. Note that if false is returned, attempts to create/use objects of this class will throw exceptions.</para>
+    ///</return>
+    ///</para>
+    /// </summary>


Suggested change

/// <summary>

/// <para>

/// Gets a value specifying whether the operating system has Dark Mode visual styles subclass and the Application can use this subclass to draw controls with Dark Mode theme.

///</para>

///<para>

///<return>

///<para> Returns true if Visual Style Dark Mode subclass is: </para>

/// <para> 1) Supported by the operating system.</para>

/// <para> 2) Enabled in the client area.</para>

/// <para> 3) operating system not ruining in high contrast mode</para>

/// <para> Otherwise, returns false. Note that if false is returned, attempts to create/use objects of this class will throw exceptions.</para>

///</return>

///</para>

/// </summary>

/// <summary>

/// Gets a value specifying whether the operating system has Dark Mode visual styles subclass and the Application can use this subclass to draw controls with Dark Mode theme.

///</summary>

/// <return>

/// <see langword="true"/> if Visual Style Dark Mode subclass is supported by the operating system,

/// enabled in the client area, and operating system not running high contrast mode.

/// Otherwise, returns <see langword="false"/>. Note that if <see langword="false"/> is returned, attempts to create/use objects of this class will throw exceptions.

/// </return>

lonitra · 2024-09-04T21:43:45Z

src/System.Windows.Forms/src/System/Windows/Forms/VisualStyles/VisualStyleRenderer.cs

+    ///</para>
+    /// </summary>
+    [Experimental(DiagnosticIDs.ExperimentalDarkMode, UrlFormat = DiagnosticIDs.UrlFormat)]
+    public static bool IsDarkModeSupported


At this point we cannot add new public API for net 9 RC2. Does this need to be public to fix rendering issues?

KlausLoeffelmann

Hey @memoarfaa,

I have a couple of additional issues which need to be addressed - most of them are just using consts for the theme names, so nothing big.

That said, while we would need to take a closer look at your proposed additional API for .NET 10, we cannot take that in RC2 for .NET 9 since we're way past code complete. Also, for new APIs, we need to bring that to the API review board, and it has to be officially discussed and then agreed to.

If you can do these changes on short notice, that would be nice, because the cut-of-date is approaching, and you bug fix would need to be tested before!

Thanks so much for doing this - we really appreciate!!

KlausLoeffelmann · 2024-09-04T21:29:59Z

src/System.Windows.Forms/src/PublicAPI.Shipped.txt

@@ -3320,6 +3320,7 @@ static System.Windows.Forms.VisualStyles.VisualStyleInformation.Url.get -> strin
 static System.Windows.Forms.VisualStyles.VisualStyleInformation.Version.get -> string!
 static System.Windows.Forms.VisualStyles.VisualStyleRenderer.IsElementDefined(System.Windows.Forms.VisualStyles.VisualStyleElement! element) -> bool
 static System.Windows.Forms.VisualStyles.VisualStyleRenderer.IsSupported.get -> bool
+static System.Windows.Forms.VisualStyles.VisualStyleRenderer.IsDarkModeSupported.get -> bool


We cannot take new APIs at this point. So, this needs to be reverted.

KlausLoeffelmann · 2024-09-04T21:30:38Z

src/System.Windows.Forms/src/System/Windows/Forms/Application.cs

@@ -379,21 +377,9 @@ private static int GetSystemColorModeInternal()
            return SystemDarkModeDisabled;
        }

-        int systemColorMode = SystemDarkModeDisabled;


This needs to be as it is, please revert this.

KlausLoeffelmann · 2024-09-04T21:31:04Z

src/System.Windows.Forms/src/System/Windows/Forms/Application.cs

-        {
-        }
-
-        return systemColorMode;


Same here - we need to keep this.

KlausLoeffelmann · 2024-09-04T21:33:10Z

src/System.Windows.Forms/src/System/Windows/Forms/Controls/ComboBox/ComboBoxRenderer.cs

-    private static readonly VisualStyleElement s_comboBoxElement = VisualStyleElement.ComboBox.DropDownButton.Normal;
+#pragma warning disable WFO5001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
+    private static readonly VisualStyleElement s_comboBoxElement = Application.IsDarkModeEnabled
+        ? VisualStyleElement.CreateElement($"{Control.DarkModeIdentifier}_{Control.ComboBoxButtonThemeIdentifier}::COMBOBOX", 1, 1)


Could you introduce a const for COMBOBOX as well?

KlausLoeffelmann · 2024-09-04T21:41:00Z

...ystem.Windows.Forms/src/System/Windows/Forms/Controls/DataGridView/DataGridViewButtonCell.cs

@@ -17,7 +17,11 @@ public partial class DataGridViewButtonCell : DataGridViewCell
    private static readonly int s_propButtonCellFlatStyle = PropertyStore.CreateKey();
    private static readonly int s_propButtonCellState = PropertyStore.CreateKey();
    private static readonly int s_propButtonCellUseColumnTextForButtonValue = PropertyStore.CreateKey();
-    private static readonly VisualStyleElement s_buttonElement = VisualStyleElement.Button.PushButton.Normal;
+#pragma warning disable WFO5001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
+    private static readonly VisualStyleElement s_darkButtonElement = VisualStyleElement.CreateElement("DarkMode_Explorer::BUTTON", 1, 1);


Actually, I do not see that you changed anything.
Can you make the changes?

KlausLoeffelmann · 2024-09-04T21:43:09Z

...ows/Forms/Controls/DataGridView/DataGridViewComboBoxCell.DataGridViewComboBoxCellRenderer.cs

+
+#pragma warning disable WFO5001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
+        private static readonly VisualStyleElement s_comboBoxReadOnlyButton = Application.IsDarkModeEnabled
+            ? VisualStyleElement.CreateElement($"{Control.DarkModeIdentifier}_{Control.ComboBoxButtonThemeIdentifier}::COMBOBOX", 5, 1)


And here! 😸

KlausLoeffelmann · 2024-09-04T21:43:42Z

...em.Windows.Forms/src/System/Windows/Forms/Controls/DataGridView/DataGridViewRowHeaderCell.cs

-    private static readonly VisualStyleElement s_headerElement = VisualStyleElement.Header.Item.Normal;
+#pragma warning disable WFO5001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
+    private static readonly VisualStyleElement s_headerElement = Application.IsDarkModeEnabled
+        ? VisualStyleElement.CreateElement($"{Control.DarkModeIdentifier}_{Control.ItemsViewThemeIdentifier}::Header", 1, 1)


Same for the "Header".

KlausLoeffelmann · 2024-09-04T21:43:57Z

...indows.Forms/src/System/Windows/Forms/Controls/DataGridView/DataGridViewTopLeftHeaderCell.cs

-    private static readonly VisualStyleElement s_headerElement = VisualStyleElement.Header.Item.Normal;
+#pragma warning disable WFO5001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
+    private static readonly VisualStyleElement s_headerElement = Application.IsDarkModeEnabled
+        ? VisualStyleElement.CreateElement($"{Control.DarkModeIdentifier}_{Control.ItemsViewThemeIdentifier}::Header", 1, 1)


And here! 😺

KlausLoeffelmann · 2024-09-04T21:44:17Z

src/System.Windows.Forms/src/System/Windows/Forms/Controls/TabControl/TabControl.cs

+#pragma warning disable WFO5001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
+            if (Application.IsDarkModeEnabled)
+            {
+                PInvoke.SendMessage(tooltipHwnd, PInvoke.TTM_SETWINDOWTHEME, default, "DarkMode_Explorer");


Can you use the existing const here?

KlausLoeffelmann · 2024-09-04T21:47:07Z

src/System.Windows.Forms/src/System/Windows/Forms/VisualStyles/VisualStyleRenderer.cs

+    {
+        get
+        {
+            bool supported = AreClientAreaVisualStylesSupported;


This is too invasive a change this late in the game.
Can we revert this to the existing method, because that had been tested exhaustively?

willibrandon · 2024-11-14T15:40:00Z

src/System.Windows.Forms/src/System/Windows/Forms/Controls/TabControl/TabControl.cs

+#pragma warning disable WFO5001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
+        if (Application.IsDarkModeEnabled && GetStyle(ControlStyles.ApplyThemingImplicitly))
+        {
+            _ = PInvoke.SetWindowTheme(


If not all tabs can be shown at once, the tab control will display an up-down control that will also need to be styled.

memoarfaa added 3 commits August 25, 2024 17:57

Add dark mode theme to tab control without tab appearance property su…

2b3545c

…pport.

Add Dark Mode theme to rows/columns and ColumnHeader/RowHeader in the…

7e309f4

… DataGridView

Remove weak dependency on Windows Registry Key and add IsDarkModeSupp…

e96baf5

…orted Windows Registry Key may be deleted and never restored and may be exist and there is no dark mode subclass in aero.msstyles

memoarfaa requested a review from a team as a code owner August 25, 2024 17:48

memoarfaa marked this pull request as draft August 25, 2024 17:49

dotnet-policy-service bot assigned memoarfaa Aug 25, 2024

Fix build errors

cabfc15

dotnet-policy-service bot added the draft draft PR label Aug 25, 2024

memoarfaa removed their assignment Aug 25, 2024

dotnet-policy-service bot assigned memoarfaa Aug 25, 2024

RussKie reviewed Aug 26, 2024

View reviewed changes

KlausLoeffelmann reviewed Aug 26, 2024

View reviewed changes

src/System.Windows.Forms/src/System/Windows/Forms/VisualStyles/VisualStyleRenderer.cs Show resolved Hide resolved

KlausLoeffelmann reviewed Aug 26, 2024

View reviewed changes

KlausLoeffelmann added the 📭 waiting-author-feedback The team requires more information from the author label Aug 27, 2024

lonitra reviewed Aug 28, 2024

View reviewed changes

src/System.Windows.Forms/src/System/Windows/Forms/VisualStyles/VisualStyleRenderer.cs Outdated Show resolved Hide resolved

Update src/System.Windows.Forms/src/System/Windows/Forms/VisualStyles…

9c93f8c

…/VisualStyleRenderer.cs Co-authored-by: Loni Tra <[email protected]>

dotnet-policy-service bot removed the 📭 waiting-author-feedback The team requires more information from the author label Sep 3, 2024

Add reviewer recommendations

a0d17a3

memoarfaa and others added 4 commits September 4, 2024 01:14

Update src/System.Windows.Forms/src/System/Windows/Forms/Controls/Tab…

fe55b13

…Control/TabRenderer.cs Co-authored-by: Igor Velikorossov <[email protected]>

Reapply lonitra recommendation about "HTHEME"

3f9b434

Merge branch 'Feature/DarkMode' of https://github.com/memoarfaa/winforms

4070e2c

into Feature/DarkMode

Merge branch 'dotnet:main' into Feature/DarkMode

2ac8c87

lonitra reviewed Sep 4, 2024

View reviewed changes

lonitra added the 📭 waiting-author-feedback The team requires more information from the author label Sep 4, 2024

KlausLoeffelmann requested changes Sep 4, 2024

View reviewed changes

xPaw mentioned this pull request Nov 14, 2024

Darken TabControl in dark mode #12471

Open

willibrandon reviewed Nov 14, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Dark Mode Visual Style Theme Subclass #11985

Add Dark Mode Visual Style Theme Subclass #11985

memoarfaa commented Aug 25, 2024 •

edited by dotnet-policy-service bot

Loading

memoarfaa commented Aug 25, 2024 via email •

edited by KlausLoeffelmann

Loading

RussKie Aug 26, 2024

memoarfaa Sep 3, 2024

KlausLoeffelmann Sep 4, 2024

RussKie commented Aug 26, 2024 •

edited

Loading

AraHaan commented Aug 26, 2024 •

edited

Loading

KlausLoeffelmann Aug 26, 2024

KlausLoeffelmann Sep 4, 2024

lonitra left a comment

codecov bot commented Sep 3, 2024 •

edited

Loading

lonitra Sep 4, 2024

lonitra Sep 4, 2024 •

edited

Loading

lonitra Sep 4, 2024 •

edited

Loading

KlausLoeffelmann left a comment

KlausLoeffelmann Sep 4, 2024

KlausLoeffelmann Sep 4, 2024

KlausLoeffelmann Sep 4, 2024

KlausLoeffelmann Sep 4, 2024

KlausLoeffelmann Sep 4, 2024

KlausLoeffelmann Sep 4, 2024

KlausLoeffelmann Sep 4, 2024

KlausLoeffelmann Sep 4, 2024

KlausLoeffelmann Sep 4, 2024

KlausLoeffelmann Sep 4, 2024

willibrandon Nov 14, 2024

	internal const string DarkModeIdentifier = "DarkMode";
	internal const string ExplorerThemeIdentifier = "Explorer";
	internal const string ItemsViewThemeIdentifier = "ItemsView";
	internal const string ComboBoxButtonThemeIdentifier = "CFD";

	private static readonly VisualStyleElement s_darkButtonElement = VisualStyleElement.CreateElement("DarkMode_Explorer::BUTTON", 1, 1);
	private static readonly VisualStyleElement s_darkButtonElement = VisualStyleElement.CreateElement($"{Control.DarkModeIdentifier}_{Control.ExplorerThemeIdentifier}::BUTTON", 1, 1);

Add Dark Mode Visual Style Theme Subclass #11985

Are you sure you want to change the base?

Add Dark Mode Visual Style Theme Subclass #11985

Conversation

memoarfaa commented Aug 25, 2024 • edited by dotnet-policy-service bot Loading

Microsoft Reviewers: Open in CodeFlow

memoarfaa commented Aug 25, 2024 via email • edited by KlausLoeffelmann Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RussKie commented Aug 26, 2024 • edited Loading

AraHaan commented Aug 26, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lonitra left a comment

Choose a reason for hiding this comment

codecov bot commented Sep 3, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

lonitra Sep 4, 2024 • edited Loading

Choose a reason for hiding this comment

lonitra Sep 4, 2024 • edited Loading

Choose a reason for hiding this comment

KlausLoeffelmann left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

memoarfaa commented Aug 25, 2024 •

edited by dotnet-policy-service bot

Loading

memoarfaa commented Aug 25, 2024 via email •

edited by KlausLoeffelmann

Loading

RussKie commented Aug 26, 2024 •

edited

Loading

AraHaan commented Aug 26, 2024 •

edited

Loading

codecov bot commented Sep 3, 2024 •

edited

Loading

lonitra Sep 4, 2024 •

edited

Loading

lonitra Sep 4, 2024 •

edited

Loading