Added RibbonProperties.CustomIconSize

fluentribbon · Dec 27, 2023 · b23b75a · b23b75a
1 parent def513f
commit b23b75a
Show file tree

Hide file tree

Showing 18 changed files with 64 additions and 4 deletions.
diff --git a/Changelog.md b/Changelog.md
@@ -13,6 +13,7 @@
   - Performance of measuring (and thus rendering) of `RibbonTabItem` (and it's contents) was improved by reducing the amount of measures required.
     Most of the time there should only be one or two measure calls when switching tabs, compared to six or eight in case of the showcase application.
     This is mostly achieved by getting rid of internal caching. The caching turned out to be more expensive than not caching at all.
+  - Added `RibbonProperties.CustomIconSize` as an attached property. This is used inside control templates to set `CustomSize` of `IconPresenter`.
   - [#1177](../../issues/1177) - RibbonComboBox cannot be customized based on the original RibbonComboBox style (thanks @nishy2000)
   - [#1180](../../issues/1180) - Padding and BorderBrush of the gallery control do not work (thanks @nishy2000)
 

diff --git a/Fluent.Ribbon/AttachedProperties/RibbonProperties.cs b/Fluent.Ribbon/AttachedProperties/RibbonProperties.cs
@@ -326,7 +326,7 @@ public static bool GetIsElementInQuickAccessToolBar(DependencyObject element)
 
     #endregion IsElementInQuickAccessToolBarProperty
 
-    #region DesiredIconSize
+    #region IconSize
 
 #pragma warning disable WPF0010
     /// <summary>
@@ -352,4 +352,31 @@ public static IconSize GetIconSize(DependencyObject element)
     }
 
     #endregion
+
+    #region CustomIconSize
+
+#pragma warning disable WPF0010
+    /// <summary>
+    /// Defines the custom icon size for the element.
+    /// </summary>
+    public static readonly DependencyProperty CustomIconSizeProperty = DependencyProperty.RegisterAttached(
+        "CustomIconSize", typeof(Size), typeof(RibbonProperties), new PropertyMetadata(default(Size)));
+#pragma warning restore WPF0010
+
+    /// <summary>Helper for setting <see cref="CustomIconSizeProperty"/> on <paramref name="element"/>.</summary>
+    public static void SetCustomIconSize(DependencyObject element, Size value)
+    {
+        element.SetValue(CustomIconSizeProperty, value);
+    }
+
+    /// <summary>Helper for getting <see cref="CustomIconSizeProperty"/> from <paramref name="element"/>.</summary>
+    [AttachedPropertyBrowsableForType(typeof(IRibbonControl))]
+    [AttachedPropertyBrowsableForType(typeof(IMediumIconProvider))]
+    [AttachedPropertyBrowsableForType(typeof(ILargeIconProvider))]
+    public static Size GetCustomIconSize(DependencyObject element)
+    {
+        return (Size)element.GetValue(CustomIconSizeProperty);
+    }
+
+    #endregion
 }
diff --git a/Fluent.Ribbon/Themes/Controls/ApplicationMenuItem.xaml b/Fluent.Ribbon/Themes/Controls/ApplicationMenuItem.xaml
@@ -87,6 +87,7 @@
                                   HorizontalAlignment="Center"
                                   VerticalAlignment="Top"
                                   IconSize="{Binding Path=(Fluent:RibbonProperties.IconSize), RelativeSource={RelativeSource TemplatedParent}}"
+                                  CustomSize="{Binding Path=(Fluent:RibbonProperties.CustomIconSize), RelativeSource={RelativeSource TemplatedParent}}"
                                   LargeIcon="{Binding Icon, RelativeSource={RelativeSource TemplatedParent}}" />
         </Grid>
         <ControlTemplate.Triggers>
@@ -195,6 +196,7 @@
                                   HorizontalAlignment="Center"
                                   VerticalAlignment="Top"
                                   IconSize="{Binding Path=(Fluent:RibbonProperties.IconSize), RelativeSource={RelativeSource TemplatedParent}}"
+                                  CustomSize="{Binding Path=(Fluent:RibbonProperties.CustomIconSize), RelativeSource={RelativeSource TemplatedParent}}"
                                   LargeIcon="{Binding Icon, RelativeSource={RelativeSource TemplatedParent}}" />
             <Path x:Name="path"
                   Grid.Column="3"
@@ -484,6 +486,7 @@
                                   HorizontalAlignment="Center"
                                   VerticalAlignment="Top"
                                   IconSize="{Binding Path=(Fluent:RibbonProperties.IconSize), RelativeSource={RelativeSource TemplatedParent}}"
+                                  CustomSize="{Binding Path=(Fluent:RibbonProperties.CustomIconSize), RelativeSource={RelativeSource TemplatedParent}}"
                                   LargeIcon="{Binding Icon, RelativeSource={RelativeSource TemplatedParent}}" />
             <Path x:Name="path"
                   Grid.Column="3"
@@ -696,6 +699,7 @@
                                   HorizontalAlignment="Center"
                                   VerticalAlignment="Top"
                                   IconSize="{Binding Path=(Fluent:RibbonProperties.IconSize), RelativeSource={RelativeSource TemplatedParent}}"
+                                  CustomSize="{Binding Path=(Fluent:RibbonProperties.CustomIconSize), RelativeSource={RelativeSource TemplatedParent}}"
                                   LargeIcon="{Binding Icon, RelativeSource={RelativeSource TemplatedParent}}" />
         </Grid>
         <ControlTemplate.Triggers>
@@ -792,6 +796,7 @@
                                   HorizontalAlignment="Center"
                                   VerticalAlignment="Top"
                                   IconSize="{Binding Path=(Fluent:RibbonProperties.IconSize), RelativeSource={RelativeSource TemplatedParent}}"
+                                  CustomSize="{Binding Path=(Fluent:RibbonProperties.CustomIconSize), RelativeSource={RelativeSource TemplatedParent}}"
                                   LargeIcon="{Binding Icon, RelativeSource={RelativeSource TemplatedParent}}" />
             <Path x:Name="path"
                   Grid.Column="3"
@@ -1063,6 +1068,7 @@
                                   HorizontalAlignment="Center"
                                   VerticalAlignment="Top"
                                   IconSize="{Binding Path=(Fluent:RibbonProperties.IconSize), RelativeSource={RelativeSource TemplatedParent}}"
+                                  CustomSize="{Binding Path=(Fluent:RibbonProperties.CustomIconSize), RelativeSource={RelativeSource TemplatedParent}}"
                                   LargeIcon="{Binding Icon, RelativeSource={RelativeSource TemplatedParent}}" />
             <Path x:Name="path"
                   Grid.Column="3"

diff --git a/Fluent.Ribbon/Themes/Controls/BackstageTabControl.xaml b/Fluent.Ribbon/Themes/Controls/BackstageTabControl.xaml
@@ -18,6 +18,7 @@
                                       HorizontalAlignment="Center"
                                       VerticalAlignment="Center"
                                       IconSize="{Binding Path=(Fluent:RibbonProperties.IconSize), RelativeSource={RelativeSource TemplatedParent}}"
+                                      CustomSize="{Binding Path=(Fluent:RibbonProperties.CustomIconSize), RelativeSource={RelativeSource TemplatedParent}}"
                                       SmallIcon="{Binding Icon, RelativeSource={RelativeSource TemplatedParent}}" />
 
                 <ContentControl x:Name="controlLabel"

diff --git a/Fluent.Ribbon/Themes/Controls/BackstageTabItem.xaml b/Fluent.Ribbon/Themes/Controls/BackstageTabItem.xaml
@@ -26,6 +26,7 @@
                                       HorizontalAlignment="Center"
                                       VerticalAlignment="Center"
                                       IconSize="{Binding Path=(Fluent:RibbonProperties.IconSize), RelativeSource={RelativeSource TemplatedParent}}"
+                                      CustomSize="{Binding Path=(Fluent:RibbonProperties.CustomIconSize), RelativeSource={RelativeSource TemplatedParent}}"
                                       SmallIcon="{Binding Icon, RelativeSource={RelativeSource TemplatedParent}}" />
 
                 <ContentControl x:Name="PART_Header"

diff --git a/Fluent.Ribbon/Themes/Controls/Button.xaml b/Fluent.Ribbon/Themes/Controls/Button.xaml
@@ -72,6 +72,7 @@
                 <Fluent:IconPresenter x:Name="iconImage"
                                       Margin="0 2 0 0"
                                       IconSize="{Binding Path=(Fluent:RibbonProperties.IconSize), RelativeSource={RelativeSource TemplatedParent}}"
+                                      CustomSize="{Binding Path=(Fluent:RibbonProperties.CustomIconSize), RelativeSource={RelativeSource TemplatedParent}}"
                                       LargeIcon="{Binding LargeIcon, RelativeSource={RelativeSource TemplatedParent}}"
                                       MediumIcon="{Binding MediumIcon, RelativeSource={RelativeSource TemplatedParent}}"
                                       SmallIcon="{Binding Icon, RelativeSource={RelativeSource TemplatedParent}}" />
@@ -141,6 +142,7 @@
                       VerticalAlignment="Center">
                     <Fluent:IconPresenter x:Name="iconImage"
                                           IconSize="{Binding Path=(Fluent:RibbonProperties.IconSize), RelativeSource={RelativeSource TemplatedParent}}"
+                                          CustomSize="{Binding Path=(Fluent:RibbonProperties.CustomIconSize), RelativeSource={RelativeSource TemplatedParent}}"
                                           LargeIcon="{Binding LargeIcon, RelativeSource={RelativeSource TemplatedParent}}"
                                           MediumIcon="{Binding MediumIcon, RelativeSource={RelativeSource TemplatedParent}}"
                                           SmallIcon="{Binding Icon, RelativeSource={RelativeSource TemplatedParent}}" />

diff --git a/Fluent.Ribbon/Themes/Controls/CheckBox.xaml b/Fluent.Ribbon/Themes/Controls/CheckBox.xaml
@@ -135,7 +135,8 @@
                               VerticalAlignment="Center"
                               Visibility="Collapsed">
                             <Fluent:IconPresenter x:Name="iconImage"
-                                                  IconSize="{TemplateBinding Fluent:RibbonProperties.IconSize}"
+                                                  IconSize="{Binding Path=(Fluent:RibbonProperties.IconSize), RelativeSource={RelativeSource TemplatedParent}}"
+                                                  CustomSize="{Binding Path=(Fluent:RibbonProperties.CustomIconSize), RelativeSource={RelativeSource TemplatedParent}}"
                                                   LargeIcon="{Binding LargeIcon, RelativeSource={RelativeSource TemplatedParent}}"
                                                   MediumIcon="{Binding MediumIcon, RelativeSource={RelativeSource TemplatedParent}}"
                                                   SmallIcon="{Binding Icon, RelativeSource={RelativeSource TemplatedParent}}" />

diff --git a/Fluent.Ribbon/Themes/Controls/ComboBox.xaml b/Fluent.Ribbon/Themes/Controls/ComboBox.xaml
@@ -89,6 +89,7 @@
                                       Margin="3 0 0 0"
                                       VerticalAlignment="Center"
                                       IconSize="{Binding Path=(Fluent:RibbonProperties.IconSize), RelativeSource={RelativeSource TemplatedParent}}"
+                                      CustomSize="{Binding Path=(Fluent:RibbonProperties.CustomIconSize), RelativeSource={RelativeSource TemplatedParent}}"
                                       MediumIcon="{Binding MediumIcon, RelativeSource={RelativeSource TemplatedParent}}"
                                       SmallIcon="{Binding Icon, RelativeSource={RelativeSource TemplatedParent}}" />
 

diff --git a/Fluent.Ribbon/Themes/Controls/DropDownButton.xaml b/Fluent.Ribbon/Themes/Controls/DropDownButton.xaml
@@ -117,6 +117,7 @@
                                           HorizontalAlignment="Center"
                                           VerticalAlignment="Center"
                                           IconSize="{Binding Path=(Fluent:RibbonProperties.IconSize), RelativeSource={RelativeSource TemplatedParent}}"
+                                          CustomSize="{Binding Path=(Fluent:RibbonProperties.CustomIconSize), RelativeSource={RelativeSource TemplatedParent}}"
                                           LargeIcon="{Binding LargeIcon, RelativeSource={RelativeSource TemplatedParent}}"
                                           MediumIcon="{Binding MediumIcon, RelativeSource={RelativeSource TemplatedParent}}"
                                           SmallIcon="{Binding Icon, RelativeSource={RelativeSource TemplatedParent}}" />
@@ -223,6 +224,7 @@
                           VerticalAlignment="Center">
                         <Fluent:IconPresenter x:Name="iconImage"
                                               IconSize="{Binding Path=(Fluent:RibbonProperties.IconSize), RelativeSource={RelativeSource TemplatedParent}}"
+                                              CustomSize="{Binding Path=(Fluent:RibbonProperties.CustomIconSize), RelativeSource={RelativeSource TemplatedParent}}"
                                               LargeIcon="{Binding LargeIcon, RelativeSource={RelativeSource TemplatedParent}}"
                                               MediumIcon="{Binding MediumIcon, RelativeSource={RelativeSource TemplatedParent}}"
                                               SmallIcon="{Binding Icon, RelativeSource={RelativeSource TemplatedParent}}" />

diff --git a/Fluent.Ribbon/Themes/Controls/InRibbonGallery.xaml b/Fluent.Ribbon/Themes/Controls/InRibbonGallery.xaml
@@ -97,6 +97,7 @@
                                           HorizontalAlignment="Center"
                                           VerticalAlignment="Center"
                                           IconSize="{Binding Path=(Fluent:RibbonProperties.IconSize), RelativeSource={RelativeSource TemplatedParent}}"
+                                          CustomSize="{Binding Path=(Fluent:RibbonProperties.CustomIconSize), RelativeSource={RelativeSource TemplatedParent}}"
                                           LargeIcon="{Binding LargeIcon, RelativeSource={RelativeSource TemplatedParent}}"
                                           MediumIcon="{Binding MediumIcon, RelativeSource={RelativeSource TemplatedParent}}"
                                           SmallIcon="{Binding Icon, RelativeSource={RelativeSource TemplatedParent}}" />
@@ -173,6 +174,7 @@
                       VerticalAlignment="Center">
                     <Fluent:IconPresenter x:Name="iconImage"
                                           IconSize="{Binding Path=(Fluent:RibbonProperties.IconSize), RelativeSource={RelativeSource TemplatedParent}}"
+                                          CustomSize="{Binding Path=(Fluent:RibbonProperties.CustomIconSize), RelativeSource={RelativeSource TemplatedParent}}"
                                           LargeIcon="{Binding LargeIcon, RelativeSource={RelativeSource TemplatedParent}}"
                                           MediumIcon="{Binding MediumIcon, RelativeSource={RelativeSource TemplatedParent}}"
                                           SmallIcon="{Binding Icon, RelativeSource={RelativeSource TemplatedParent}}" />

diff --git a/Fluent.Ribbon/Themes/Controls/MenuItem.xaml b/Fluent.Ribbon/Themes/Controls/MenuItem.xaml
@@ -42,6 +42,7 @@
                                       HorizontalAlignment="Center"
                                       VerticalAlignment="Center"
                                       IconSize="{Binding Path=(Fluent:RibbonProperties.IconSize), RelativeSource={RelativeSource TemplatedParent}}"
+                                      CustomSize="{Binding Path=(Fluent:RibbonProperties.CustomIconSize), RelativeSource={RelativeSource TemplatedParent}}"
                                       SmallIcon="{Binding Icon, RelativeSource={RelativeSource TemplatedParent}}" />
             </Border>
             <Image x:Name="checkedImage"
@@ -136,6 +137,7 @@
                                       HorizontalAlignment="Center"
                                       VerticalAlignment="Center"
                                       IconSize="{Binding Path=(Fluent:RibbonProperties.IconSize), RelativeSource={RelativeSource TemplatedParent}}"
+                                      CustomSize="{Binding Path=(Fluent:RibbonProperties.CustomIconSize), RelativeSource={RelativeSource TemplatedParent}}"
                                       SmallIcon="{Binding Icon, RelativeSource={RelativeSource TemplatedParent}}" />
             </Border>
             <Image x:Name="checkedImage"
@@ -275,6 +277,7 @@
                                       HorizontalAlignment="Center"
                                       VerticalAlignment="Center"
                                       IconSize="{Binding Path=(Fluent:RibbonProperties.IconSize), RelativeSource={RelativeSource TemplatedParent}}"
+                                      CustomSize="{Binding Path=(Fluent:RibbonProperties.CustomIconSize), RelativeSource={RelativeSource TemplatedParent}}"
                                       SmallIcon="{Binding Icon, RelativeSource={RelativeSource TemplatedParent}}" />
             </Border>
             <Image x:Name="checkedImage"
@@ -407,6 +410,7 @@
                                       HorizontalAlignment="Center"
                                       VerticalAlignment="Center"
                                       IconSize="{Binding Path=(Fluent:RibbonProperties.IconSize), RelativeSource={RelativeSource TemplatedParent}}"
+                                      CustomSize="{Binding Path=(Fluent:RibbonProperties.CustomIconSize), RelativeSource={RelativeSource TemplatedParent}}"
                                       SmallIcon="{Binding Icon, RelativeSource={RelativeSource TemplatedParent}}" />
             </Border>
             <Image x:Name="checkedImage"

diff --git a/Fluent.Ribbon/Themes/Controls/RadioButton.xaml b/Fluent.Ribbon/Themes/Controls/RadioButton.xaml
@@ -99,7 +99,8 @@
                           VerticalAlignment="Center"
                           Visibility="Collapsed">
                         <Fluent:IconPresenter x:Name="iconImage"
-                                              IconSize="{TemplateBinding Fluent:RibbonProperties.IconSize}"
+                                              IconSize="{Binding Path=(Fluent:RibbonProperties.IconSize), RelativeSource={RelativeSource TemplatedParent}}"
+                                              CustomSize="{Binding Path=(Fluent:RibbonProperties.CustomIconSize), RelativeSource={RelativeSource TemplatedParent}}"
                                               LargeIcon="{Binding LargeIcon, RelativeSource={RelativeSource TemplatedParent}}"
                                               MediumIcon="{Binding MediumIcon, RelativeSource={RelativeSource TemplatedParent}}"
                                               SmallIcon="{Binding Icon, RelativeSource={RelativeSource TemplatedParent}}" />

diff --git a/Fluent.Ribbon/Themes/Controls/RibbonGroupBox.xaml b/Fluent.Ribbon/Themes/Controls/RibbonGroupBox.xaml
@@ -367,6 +367,7 @@
                             BorderThickness="1">
                         <Fluent:IconPresenter x:Name="iconImage"
                                               IconSize="{Binding Path=(Fluent:RibbonProperties.IconSize), RelativeSource={RelativeSource TemplatedParent}}"
+                                              CustomSize="{Binding Path=(Fluent:RibbonProperties.CustomIconSize), RelativeSource={RelativeSource TemplatedParent}}"
                                               MediumIcon="{Binding MediumIcon, RelativeSource={RelativeSource TemplatedParent}}"
                                               SmallIcon="{Binding Icon, RelativeSource={RelativeSource TemplatedParent}}" />
                     </Border>
@@ -530,6 +531,7 @@
                           IsHitTestVisible="False">
                         <Fluent:IconPresenter x:Name="iconImage"
                                               IconSize="{Binding Path=(Fluent:RibbonProperties.IconSize), RelativeSource={RelativeSource TemplatedParent}}"
+                                              CustomSize="{Binding Path=(Fluent:RibbonProperties.CustomIconSize), RelativeSource={RelativeSource TemplatedParent}}"
                                               MediumIcon="{Binding MediumIcon, RelativeSource={RelativeSource TemplatedParent}}"
                                               SmallIcon="{Binding Icon, RelativeSource={RelativeSource TemplatedParent}}" />
                         <Border Margin="0"

diff --git a/Fluent.Ribbon/Themes/Controls/RibbonTabControl.xaml b/Fluent.Ribbon/Themes/Controls/RibbonTabControl.xaml
@@ -19,6 +19,7 @@
                                       HorizontalAlignment="Center"
                                       VerticalAlignment="Center"
                                       IconSize="{Binding Path=(Fluent:RibbonProperties.IconSize), RelativeSource={RelativeSource TemplatedParent}}"
+                                      CustomSize="{Binding Path=(Fluent:RibbonProperties.CustomIconSize), RelativeSource={RelativeSource TemplatedParent}}"
                                       SmallIcon="{Binding Icon, RelativeSource={RelativeSource TemplatedParent}}" />
                 <Popup x:Name="PART_Popup"
                        Margin="0 0 -4 0"