{"id":366,"date":"2013-01-02T00:05:16","date_gmt":"2013-01-01T13:05:16","guid":{"rendered":"http:\/\/blog.quppa.net\/?p=366"},"modified":"2013-01-02T00:05:16","modified_gmt":"2013-01-01T13:05:16","slug":"retrieving-windows-8-theme-colours","status":"publish","type":"post","link":"https:\/\/www.quppa.net\/blog\/2013\/01\/02\/retrieving-windows-8-theme-colours\/","title":{"rendered":"Retrieving Windows 8 Theme Colours"},"content":{"rendered":"

See also<\/i>: Windows 8 Theme Colours Reference<\/a>.<\/p>\n

Windows 8 doesn\u2019t offer developers access to system theme colours, unlike its cousin, Windows Phone<\/a>. Even for a version 1 product, this seems like a strange omission. Then again, we still don\u2019t have a working public API for retrieving the Aero glass colour<\/a> (or whatever we call it now that Aero\u2019s gone) 6 years after the release of Windows Vista.<\/p>\n

The functions that the system uses to retrieve colours are defined in UxTheme.dll. In particular, we\u2019re interested in GetImmersiveColorSetCount (export #94), GetImmersiveColorFromColorSetEx (export #95), GetImmersiveColorTypeFromName (export #96), GetImmersiveUserColorSetPreference (export #98) and GetImmersiveColorNamedTypeByIndex (export #100). Relying on undocumented functions is a bad idea<\/a>, and will cause your program to fail certification<\/strong>, so you won\u2019t be able to use them in apps distributed through the Windows Store anyway.<\/p>\n

For desktop developers who still want to use these functions, read on. Just assume that they\u2019ll break in future versions of Windows (or even with patches to Windows 8).<\/p>\n

\"Screenshot<\/a><\/p>\n

<\/p>\n

There are 25 colour sets available in Windows 8, pictured above. Users can switch between these in the Metro control panel (under Personalise > Start screen). Additionally, when a high contrast theme is enabled, colours in the start screen are based on traditional window element colours<\/a>, retrieved with the GetSysColor function<\/a>. With the four high contrast themes included in Windows 8, this means there are effectively 29 different colour sets for a standard setup. Use the GetImmersiveColorSetCount function to retrieve the number of colour sets available and the GetImmersiveUserColorSetPreference function to retrieve the ID of the active colour set. The ID is also stored in the registry key HKCUSoftwareMicrosoftWindowsCurrentVersionExplorerAccent with the name ColorSet_Version3. It occurred to me that one could hard-code values from the 25 colour schemes and read this registry value, but Metro-style apps aren\u2019t even allowed to access the registry \u2013 so much for that idea.<\/p>\n

The GetImmersiveUserColorSetPreference functions takes two boolean parameters. The first should be set to true to force UxTheme to read the value stored in the registry (and update the system setting if what\u2019s in the registry is different to what\u2019s in memory). To be honest, I\u2019m not entirely sure what the second parameter does \u2013 setting it to true will stop the function attempting to retrieve the user preference a second time if the first call returns \u20131. I think this is only relevant in the event that UxTheme doesn\u2019t have permission to update the system setting with the value from the registry. In any case, you should be able to disregard these parameters in most scenarios (set them both to false).<\/p>\n

\"Screenshot<\/a><\/p>\n

The GetImmersiveColorNamedTypeByIndex function returns a (pointer to a) string containing the name of an element like \u2018StartBackground\u2019 or \u2018StartDesktopTilesBackground\u2019. There are 767 (0x2ff) names in total \u2013 unfortunately there seems to be no function to retrieve this number. To get the colour type (ID) from a name, we use the GetImmersiveColorTypeFromName function. We must prepend \u2018Immersive\u2019 to the string first, however, or the function will fail (\u2018StartBackground\u2019 becomes \u2018ImmersiveStartBackground\u2019, for example). (In fact, any 9 characters at the start will do \u2013 \u2018xxxxxxxxxStartBackground\u2019 will work just as well.)<\/p>\n

GetImmersiveColorTypeFromName returns a number between 0 and 766 (0x2fe). Only the first 108 types (0 to 107) correspond to colours that change according to the colour set \u2013 the remaining 659 are static (unless high contrast mode is enabled).<\/p>\n

GetImmersiveColorFromColorSetEx takes four parameters. The first is the colour set ID (between 0 and 24 for Windows 8) and the second is the colour type (e.g. 0 for \u2018StartBackground\u2019). If the third parameter determines whether high contrast mode should be ignored \u2013 set it to 1 to retrieve the active colour set\u2019s colours even when high contrast mode is enabled. The fourth parameter can be set to 1 to force UxTheme to check whether the system is in high contrast mode even with it already thinks it is (this check would otherwise only occur if high contrast mode had previously not been enabled).<\/p>\n

Detecting User Preference Updates<\/h1>\n

Listen for WM_SETTINGCHANGE to detect when the user changes the colour scheme. lParam will point to a string with the value \u2018ImmersiveColorSet\u2019. When high contrast mode is enabled or disabled, lParam will point to a string with the value \u2018WindowsThemeElement\u2019.<\/p>\n

P\/Invoke Signatures<\/h1>\n

These P\/Invoke signatures should be of help to C# developers wishing to use these functions in desktop programs (again, assume they could stop working at any time):<\/p>\n

[DllImport("uxtheme.dll", EntryPoint = "#94")]\npublic static extern int GetImmersiveColorSetCount();<\/pre>\n
\/\/\/ <summary>\n\/\/\/ Retrieves an immersive colour from the specified colour set.\n\/\/\/ <\/summary>\n\/\/\/ <param name=\"dwImmersiveColorSet\">Colour set index. Use <see cref=\"GetImmersiveColorSetCount\"\/> to get the number of colour sets available.<\/param>\n\/\/\/ <param name=\"dwImmersiveColorType\">The colour type. Use <see cref=\"GetImmersiveColorTypeFromName\"\/> to get the type from an element name.<\/param>\n\/\/\/ <param name=\"bIgnoreHighContrast\">Set this to true to return colours from the current colour set, even if a high contrast theme is being used.<\/param>\n\/\/\/ <param name=\"dwHighContrastCacheMode\">Set this to 1 to force UxTheme to check whether high contrast mode is enabled. If this is set to 0, UxTheme will only perform this check if high contrast mode is currently disabled.<\/param>\n\/\/\/ <returns>Returns a colour (0xAABBGGRR).<\/returns>\n[DllImport(\"uxtheme.dll\", EntryPoint = \"#95\")]\npublic static extern uint GetImmersiveColorFromColorSetEx(uint dwImmersiveColorSet, uint dwImmersiveColorType, bool bIgnoreHighContrast, uint dwHighContrastCacheMode);<\/pre>\n
\/\/\/ <summary>\n\/\/\/ Retrieves an immersive colour type given its name.\n\/\/\/ <\/summary>\n\/\/\/ <param name=\"pName\">Pointer to a string containing the name preprended with 9 characters (e.g. \"Immersive\" + name).<\/param>\n\/\/\/ <returns>Colour type.<\/returns>\n[DllImport(\"uxtheme.dll\", EntryPoint = \"#96\")]\npublic static extern uint GetImmersiveColorTypeFromName(IntPtr pName);<\/pre>\n
\/\/\/ <summary>\n\/\/\/ Gets the user's colour set preference (or default colour set if the user isn't allowed to modify this setting according to group policy).\n\/\/\/ <\/summary>\n\/\/\/ <param name=\"bForceCheckRegistry\">Forces update from registry (HKCUSoftwareMicrosoftWindowsCurrentVersionExplorerAccentColorSet_Version3).<\/param>\n\/\/\/ <param name=\"bSkipCheckOnFail\">Skip second check if first result is -1.<\/param>\n\/\/\/ <returns>User colour set preference.<\/returns>\n[DllImport(\"uxtheme.dll\", EntryPoint = \"#98\")]\npublic static extern int GetImmersiveUserColorSetPreference(bool bForceCheckRegistry, bool bSkipCheckOnFail);<\/pre>\n
\/\/\/ <summary>\n\/\/\/ Retrieves names of colour types by index.\n\/\/\/ <\/summary>\n\/\/\/ <param name=\"dwIndex\">Colour type index (0 to 766\/0x2fe).<\/param>\n\/\/\/ <returns>Pointer to a string containing the colour type's name.<\/returns>\n[DllImport(\"uxtheme.dll\", EntryPoint = \"#100\")]\npublic static extern IntPtr GetImmersiveColorNamedTypeByIndex(uint dwIndex);<\/pre>\n
Sample Code (C#)<\/h1>\n
The following code retrieves the \u2018StartSelectionBackground\u2019 colour from the active colour set (assuming the above P\/Invoke signatures).<\/p>\n
int colourset = Colour.GetImmersiveUserColorSetPreference(false, false);\nIntPtr pElementName = Marshal.StringToHGlobalUni("ImmersiveStartSelectionBackground");\nuint type = Colour.GetImmersiveColorTypeFromName(pElementName);\nMarshal.FreeCoTaskMem(pElementName);\nuint colourdword = Colour.GetImmersiveColorFromColorSetEx((uint)colourset, type, false, 0);\nbyte[] colourbytes = new byte[4];\ncolourbytes[0] = (byte)((0xFF000000 & colourdword) >> 24); \/\/ A\ncolourbytes[1] = (byte)((0x00FF0000 & colourdword) >> 16); \/\/ B\ncolourbytes[2] = (byte)((0x0000FF00 & colourdword) >> 8); \/\/ G\ncolourbytes[3] = (byte)(0x000000FF & colourdword); \/\/ R\nColor colour = Color.FromArgb(colourbytes[0], colourbytes[3], colourbytes[2], colourbytes[1]);<\/pre>\n","protected":false},"excerpt":{"rendered":"
See also: Windows 8 Theme Colours Reference. Windows 8 doesn\u2019t offer developers access to system theme colours, unlike its cousin, Windows Phone. Even for a version 1 product, this seems like a strange omission. Then again, we still don\u2019t have a working public API for retrieving the Aero glass colour (or whatever we call it … Continue reading “Retrieving Windows 8 Theme Colours”<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[6,9],"tags":[28,34,35,83,160,171,174,181],"class_list":["post-366","post","type-post","status-publish","format-standard","hentry","category-programming","category-windows","tag-c","tag-colour","tag-colours","tag-metro","tag-uxtheme","tag-windows-2","tag-windows-8","tag-winrt"],"_links":{"self":[{"href":"https:\/\/www.quppa.net\/blog\/wp-json\/wp\/v2\/posts\/366","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.quppa.net\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.quppa.net\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.quppa.net\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.quppa.net\/blog\/wp-json\/wp\/v2\/comments?post=366"}],"version-history":[{"count":0,"href":"https:\/\/www.quppa.net\/blog\/wp-json\/wp\/v2\/posts\/366\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.quppa.net\/blog\/wp-json\/wp\/v2\/media?parent=366"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.quppa.net\/blog\/wp-json\/wp\/v2\/categories?post=366"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.quppa.net\/blog\/wp-json\/wp\/v2\/tags?post=366"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}