Skip to content

Adding doc comments for ThemeMode, ThemeModeConverter introduced in PresentationFramework #10369

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

Merged
merged 5 commits into from
Sep 13, 2024
Merged

Adding doc comments for ThemeMode, ThemeModeConverter introduced in PresentationFramework #10369

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
cc14260
Adding doc comments for ThemeMode, ThemeModeConverter introduced in P…
dipeshmsft Sep 6, 2024
a354091
Added documentation for SystemColors.AccentColor's
dipeshmsft Sep 6, 2024
cecbea7
Resolved PR Comments
dipeshmsft Sep 10, 2024
d797166
Resolving PR Comments 2
dipeshmsft Sep 10, 2024
8152895
Fixed ThemeModeConverter docs
dipeshmsft Sep 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 21 additions & 2 deletions xml/System.Windows/Application.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2476,9 +2476,28 @@ This example illustrates how to use XAML together with application-scope resourc
<ReturnType>System.Windows.ThemeMode</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets the Fluent theme mode of the application.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remarks>
<para>Setting this property controls if Fluent theme is loaded in Light, Dark or System mode.</para>
<para>It also controls the application of backdrop and darkmode on window.</para>
<para>The four values for the ThemeMode enum are :</para>
<para>
<see cref="P:System.Windows.ThemeMode.None" /> - No Fluent theme is loaded.</para>
<para>
<see cref="P:System.Windows.ThemeMode.System" /> - Fluent theme is loaded based on the system theme.</para>
<para>
<see cref="P:System.Windows.ThemeMode.Light" /> - Fluent theme is loaded in Light mode.</para>
<para>
<see cref="P:System.Windows.ThemeMode.Dark" /> - Fluent theme is loaded in Dark mode.</para>
<para>These values are predefined in <see cref="P:System.Windows.Application.ThemeMode" /> struct The default value is <see cref="P:System.Windows.ThemeMode.None" />.</para>
<para>
<see cref="P:System.Windows.Application.ThemeMode" /> and <see cref="P:System.Windows.Application.Resources" /> are designed to be in sync with each other.</para>
<para>Syncing is done in order to avoid UI inconsistencies, where the window is in dark mode but the controls within are in light mode or vice versa.</para>
<para>Setting this property loads the Fluent theme dictionaries in the application resources.</para>
<para>So, if you set this property, it is preferrable to not include Fluent theme dictionaries in the application resources manually. If you do, the Fluent theme dictionaries added in the application resources will take precedence over the ones added by setting this property.</para>
<para>This property is experimental and may be removed in future versions.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="TryFindResource">
Expand Down
74 changes: 39 additions & 35 deletions xml/System.Windows/SystemColors.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
<ReturnType>System.Windows.Media.Color</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the system accent color that's set by the user in OS settings.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -71,9 +71,13 @@
<ReturnType>System.Windows.Media.SolidColorBrush</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the brush corresponding to the <see cref="P:System.Windows.SystemColors.AccentColor" /> color.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remarks>
<para>
<see cref="P:System.Windows.SystemColors.AccentColor" /> is the system accent color that's set by the user in OS settings.</para>
<para>When <see cref="P:System.Windows.SystemParameters.HighContrast" /> is <see langword="true" />, this property returns <see cref="P:System.Windows.SystemColors.HighlightTextBrush" />.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="AccentColorBrushKey">
Expand All @@ -92,7 +96,7 @@
<ReturnType>System.Windows.ResourceKey</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the <see cref="P:System.Windows.SystemColors.AccentColorBrush" /> system resource key.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -113,7 +117,7 @@
<ReturnType>System.Windows.Media.Color</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the dark shade of the system accent color.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -134,9 +138,9 @@
<ReturnType>System.Windows.Media.SolidColorBrush</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the brush corresponding to the <see cref="P:System.Windows.SystemColors.AccentColorDark1" /> color.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remarks>When <see cref="P:System.Windows.SystemParameters.HighContrast" /> is <see langword="true" />, this property returns <see cref="P:System.Windows.SystemColors.HighlightTextBrush" />.</remarks>
</Docs>
</Member>
<Member MemberName="AccentColorDark1BrushKey">
Expand All @@ -155,7 +159,7 @@
<ReturnType>System.Windows.ResourceKey</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the <see cref="P:System.Windows.SystemColors.AccentColorDark1Brush" /> system resource key.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -176,7 +180,7 @@
<ReturnType>System.Windows.ResourceKey</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the <see cref="P:System.Windows.SystemColors.AccentColorDark1" /> system resource key.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -197,7 +201,7 @@
<ReturnType>System.Windows.Media.Color</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the darker shade of the system accent color.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -218,9 +222,9 @@
<ReturnType>System.Windows.Media.SolidColorBrush</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the brush corresponding to the <see cref="P:System.Windows.SystemColors.AccentColorDark2" /> color.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remarks>When <see cref="P:System.Windows.SystemParameters.HighContrast" /> is <see langword="true" />, this property returns <see cref="P:System.Windows.SystemColors.HighlightTextBrush" />.</remarks>
</Docs>
</Member>
<Member MemberName="AccentColorDark2BrushKey">
Expand All @@ -239,7 +243,7 @@
<ReturnType>System.Windows.ResourceKey</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the <see cref="P:System.Windows.SystemColors.AccentColorDark2Brush" /> system resource key.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -260,7 +264,7 @@
<ReturnType>System.Windows.ResourceKey</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the <see cref="P:System.Windows.SystemColors.AccentColorDark2" /> system resource key.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -281,7 +285,7 @@
<ReturnType>System.Windows.Media.Color</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the darkest shade of the system accent color.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -302,9 +306,9 @@
<ReturnType>System.Windows.Media.SolidColorBrush</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the brush corresponding to the <see cref="P:System.Windows.SystemColors.AccentColorDark3" /> color.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remarks>When <see cref="P:System.Windows.SystemParameters.HighContrast" /> is <see langword="true" />, this property returns <see cref="P:System.Windows.SystemColors.HighlightTextBrush" />.</remarks>
</Docs>
</Member>
<Member MemberName="AccentColorDark3BrushKey">
Expand All @@ -323,7 +327,7 @@
<ReturnType>System.Windows.ResourceKey</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the <see cref="P:System.Windows.SystemColors.AccentColorDark3Brush" /> system resource key.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -344,7 +348,7 @@
<ReturnType>System.Windows.ResourceKey</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the <see cref="P:System.Windows.SystemColors.AccentColorDark3" /> system resource key.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -365,7 +369,7 @@
<ReturnType>System.Windows.ResourceKey</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the <see cref="P:System.Windows.SystemColors.AccentColor" /> system resource key.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -386,7 +390,7 @@
<ReturnType>System.Windows.Media.Color</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the light shade of the system accent color.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -407,9 +411,9 @@
<ReturnType>System.Windows.Media.SolidColorBrush</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the brush corresponding to the <see cref="P:System.Windows.SystemColors.AccentColorLight1" /> color.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remarks>When <see cref="P:System.Windows.SystemParameters.HighContrast" /> is <see langword="true" />, this property returns <see cref="P:System.Windows.SystemColors.HighlightTextBrush" />.</remarks>
</Docs>
</Member>
<Member MemberName="AccentColorLight1BrushKey">
Expand All @@ -428,7 +432,7 @@
<ReturnType>System.Windows.ResourceKey</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the <see cref="P:System.Windows.SystemColors.AccentColorLight1Brush" /> system resource key.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -449,7 +453,7 @@
<ReturnType>System.Windows.ResourceKey</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the <see cref="P:System.Windows.SystemColors.AccentColorLight1" /> system resource key.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -470,7 +474,7 @@
<ReturnType>System.Windows.Media.Color</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the lighter shade of the system accent color.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -491,9 +495,9 @@
<ReturnType>System.Windows.Media.SolidColorBrush</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the brush corresponding to the <see cref="P:System.Windows.SystemColors.AccentColorLight2" /> color.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remarks>When <see cref="P:System.Windows.SystemParameters.HighContrast" /> is <see langword="true" />, this property returns <see cref="P:System.Windows.SystemColors.HighlightTextBrush" />.</remarks>
</Docs>
</Member>
<Member MemberName="AccentColorLight2BrushKey">
Expand All @@ -512,7 +516,7 @@
<ReturnType>System.Windows.ResourceKey</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the <see cref="P:System.Windows.SystemColors.AccentColorLight2Brush" /> system resource key.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -533,7 +537,7 @@
<ReturnType>System.Windows.ResourceKey</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the <see cref="P:System.Windows.SystemColors.AccentColorLight2" /> system resource key.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -554,7 +558,7 @@
<ReturnType>System.Windows.Media.Color</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the lightest shade of the system accent color.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -575,9 +579,9 @@
<ReturnType>System.Windows.Media.SolidColorBrush</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the brush corresponding to the <see cref="P:System.Windows.SystemColors.AccentColorLight3" /> color.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remarks>When <see cref="P:System.Windows.SystemParameters.HighContrast" /> is <see langword="true" />, this property returns <see cref="P:System.Windows.SystemColors.HighlightTextBrush" />.</remarks>
</Docs>
</Member>
<Member MemberName="AccentColorLight3BrushKey">
Expand All @@ -596,7 +600,7 @@
<ReturnType>System.Windows.ResourceKey</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the <see cref="P:System.Windows.SystemColors.AccentColorLight3Brush" /> system resource key.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -617,7 +621,7 @@
<ReturnType>System.Windows.ResourceKey</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the <see cref="P:System.Windows.SystemColors.AccentColorLight3" /> system resource key.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
Loading