Fixes #340 by exposing GroupByAdvanced in Gallery and InRibbonGallery

Fluent.Ribbon.Showcase/TestContent.xaml

@@ -558,7 +558,8 @@
                         <TextBlock Tag="Group2">3 (G 2)</TextBlock>
                     </Fluent:InRibbonGallery>
 
-                    <Fluent:InRibbonGallery MinItemsInDropDownRow="5"
+                    <Fluent:InRibbonGallery Header="Many items"
+                                            MinItemsInDropDownRow="5"
                                             MaxItemsInDropDownRow="5"
                                             IsCollapsed="True"
                                             ItemHeight="100"
@@ -1270,9 +1271,7 @@
                 <Fluent:RibbonGroupBox Header="With Grouping"
                                        Name="SecondGalleryGroup">
 
-                    <!--To group items in Gallery (or InRibbonGallery) 
-                  you can use GroupBy for simplified grouping method or 
-                  use traditional method as in System.Windows.Controls.ListBox -->
+                    <!--To group items in Gallery (or InRibbonGallery) you can use GroupBy for simplified grouping method or use traditional method as in System.Windows.Controls.ListBox -->
                     <Fluent:InRibbonGallery Name="gallerySampleInRibbonGallery"
                                             MinItemsInRow="1"
                                             MaxItemsInRow="5"
@@ -1294,6 +1293,19 @@
                                                        Groups="Group B" />
                         </Fluent:InRibbonGallery.Filters>
                     </Fluent:InRibbonGallery>
+
+                    <!--To group items in Gallery (or InRibbonGallery) you can use GroupedByAdvanced as an advanced grouping method -->
+                    <Fluent:InRibbonGallery MinItemsInRow="1"
+                                            MaxItemsInRow="5"
+                                            Icon="Images\Gray.png"
+                                            Header="GroupedByAdvanced"
+                                            ItemWidth="50"
+                                            ItemHeight="18"
+                                            ItemsSource="{Binding DataItems}"
+                                            ItemTemplate="{DynamicResource middleDataItemTemplate}"
+                                            GroupByAdvanced="{Binding GroupByAdvancedSample}"
+                                            ResizeMode="Both">
+                    </Fluent:InRibbonGallery>
                 </Fluent:RibbonGroupBox>
 
                 <Fluent:RibbonGroupBox Icon="pack://application:,,,/Fluent.Ribbon.Showcase;component/Images/Default.png"

Fluent.Ribbon.Showcase/ViewModels/GallerySampleDataItemViewModel.cs

@@ -10,14 +10,17 @@ public class GallerySampleDataItemViewModel : ViewModel
         /// Gets or sets icon
         /// </summary>
         public ImageSource Icon { get; set; }
+
         /// <summary>
         /// Gets or sets large icon
         /// </summary>
         public ImageSource IconLarge { get; set; }
+
         /// <summary>
         /// Gets or sets text
         /// </summary>
         public string Text { get; set; }
+
         /// <summary>
         /// Gets or sets group name
         /// </summary>

Fluent.Ribbon.Showcase/ViewModels/MainViewModel.cs

@@ -42,6 +42,8 @@ public MainViewModel()
             this.PreviewCommand = new RelayCommand<GalleryItem>(Preview);
             this.CancelPreviewCommand = new RelayCommand<GalleryItem>(CancelPreview);
 
+            this.GroupByAdvancedSample = x => ((GallerySampleDataItemViewModel)x).Text.Substring(0, 1);
+
             this.memoryTimer = new Timer(TimeSpan.FromSeconds(5).TotalMilliseconds);
             this.memoryTimer.Elapsed += this.HandleMemoryTimer_Elapsed;
             this.memoryTimer.Start();
@@ -120,6 +122,8 @@ public GallerySampleDataItemViewModel[] DataItems
             }
         }
 
+        public Func<object, string> GroupByAdvancedSample { get; private set; }
+
         public IList<string> ManyItems
         {
             get { return this.manyItems ?? (this.manyItems = this.GenerateStrings(5000)); }

Fluent.Ribbon/Controls/Gallery.cs

@@ -10,6 +10,7 @@
 // ReSharper disable once CheckNamespace
 namespace Fluent
 {
+    using System;
     using Fluent.Internal.KnownBoxes;
 
     // TODO: add TemplatePart's in Gallery (!)
@@ -89,9 +90,27 @@ public string GroupBy
         /// Using a DependencyProperty as the backing store for GroupBy.  
         /// This enables animation, styling, binding, etc...
         /// </summary>
-        public static readonly DependencyProperty GroupByProperty =
-            DependencyProperty.Register(nameof(GroupBy), typeof(string), typeof(Gallery),
-            new PropertyMetadata());
+        public static readonly DependencyProperty GroupByProperty = DependencyProperty.Register(nameof(GroupBy), typeof(string), typeof(Gallery), new PropertyMetadata());
+
+        #endregion
+
+        #region GroupByAdvanced
+
+        /// <summary>
+        /// Gets or sets name of property which
+        /// will use to group items in the Gallery.
+        /// </summary>
+        public Func<object, string> GroupByAdvanced
+        {
+            get { return (Func<object, string>)this.GetValue(GroupByAdvancedProperty); }
+            set { this.SetValue(GroupByAdvancedProperty, value); }
+        }
+
+        /// <summary>
+        /// Using a DependencyProperty as the backing store for GroupBy.  
+        /// This enables animation, styling, binding, etc...
+        /// </summary>
+        public static readonly DependencyProperty GroupByAdvancedProperty = DependencyProperty.Register(nameof(GroupByAdvanced), typeof(Func<object, string>), typeof(Gallery), new PropertyMetadata());
 
         #endregion
 

Fluent.Ribbon/Controls/GalleryPanel.cs

@@ -30,9 +30,6 @@ public class GalleryPanel : StackPanel
         // Designate that gallery panel must be refreshed its groups
         private bool needsRefresh;
 
-        // Group name resolver
-        private Func<object, string> groupByAdvanced;
-
         #endregion
 
         #region Properties
@@ -80,9 +77,7 @@ public string GroupBy
         /// Using a DependencyProperty as the backing store for GroupBy.  
         /// This enables animation, styling, binding, etc...
         /// </summary>
-        public static readonly DependencyProperty GroupByProperty =
-            DependencyProperty.Register(nameof(GroupBy), typeof(string), typeof(GalleryPanel),
-            new PropertyMetadata(OnGroupByChanged));
+        public static readonly DependencyProperty GroupByProperty = DependencyProperty.Register(nameof(GroupBy), typeof(string), typeof(GalleryPanel), new PropertyMetadata(OnGroupByChanged));
 
         private static void OnGroupByChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
         {
@@ -95,17 +90,25 @@ private static void OnGroupByChanged(DependencyObject d, DependencyPropertyChang
         #region GroupByAdvanced
 
         /// <summary>
-        /// Gets or sets custom user method to group items. 
-        /// If this property is not null, GroupBy property is ignored
+        /// Gets or sets name of property which
+        /// will use to group items in the Gallery.
         /// </summary>
         public Func<object, string> GroupByAdvanced
         {
-            get { return this.groupByAdvanced; }
-            set
-            {
-                this.groupByAdvanced = value;
-                this.Invalidate();
-            }
+            get { return (Func<object, string>)this.GetValue(GroupByAdvancedProperty); }
+            set { this.SetValue(GroupByAdvancedProperty, value); }
+        }
+
+        /// <summary>
+        /// Using a DependencyProperty as the backing store for GroupBy.  
+        /// This enables animation, styling, binding, etc...
+        /// </summary>
+        public static readonly DependencyProperty GroupByAdvancedProperty = DependencyProperty.Register(nameof(GroupByAdvanced), typeof(Func<object, string>), typeof(GalleryPanel), new PropertyMetadata(OnGroupByAdvancedChanged));
+
+        private static void OnGroupByAdvancedChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
+        {
+            var galleryPanel = (GalleryPanel)d;
+            galleryPanel.Invalidate();
         }
 
         #endregion

Fluent.Ribbon/Controls/InRibbonGallery.cs

@@ -272,8 +272,27 @@ public string GroupBy
         /// Using a DependencyProperty as the backing store for GroupBy.  
         /// This enables animation, styling, binding, etc...
         /// </summary>
-        public static readonly DependencyProperty GroupByProperty =
-            DependencyProperty.Register(nameof(GroupBy), typeof(string), typeof(InRibbonGallery), new PropertyMetadata());
+        public static readonly DependencyProperty GroupByProperty = DependencyProperty.Register(nameof(GroupBy), typeof(string), typeof(InRibbonGallery), new PropertyMetadata());
+
+        #endregion
+
+        #region GroupByAdvanced
+
+        /// <summary>
+        /// Gets or sets name of property which
+        /// will use to group items in the Gallery.
+        /// </summary>
+        public Func<object, string> GroupByAdvanced
+        {
+            get { return (Func<object, string>)this.GetValue(GroupByAdvancedProperty); }
+            set { this.SetValue(GroupByAdvancedProperty, value); }
+        }
+
+        /// <summary>
+        /// Using a DependencyProperty as the backing store for GroupBy.  
+        /// This enables animation, styling, binding, etc...
+        /// </summary>
+        public static readonly DependencyProperty GroupByAdvancedProperty = DependencyProperty.Register(nameof(GroupByAdvanced), typeof(Func<object, string>), typeof(InRibbonGallery), new PropertyMetadata());
 
         #endregion
 
@@ -1377,6 +1396,7 @@ public virtual FrameworkElement CreateQuickAccessItem()
             var gallery = new InRibbonGallery();
             RibbonControl.BindQuickAccessItem(this, gallery);
             RibbonControl.Bind(this, gallery, nameof(this.GroupBy), GroupByProperty, BindingMode.OneWay);
+            RibbonControl.Bind(this, gallery, nameof(this.GroupByAdvanced), GroupByAdvancedProperty, BindingMode.OneWay);
             RibbonControl.Bind(this, gallery, nameof(this.ItemHeight), ItemHeightProperty, BindingMode.OneWay);
             RibbonControl.Bind(this, gallery, nameof(this.ItemWidth), ItemWidthProperty, BindingMode.OneWay);
             RibbonControl.Bind(this, gallery, nameof(this.ResizeMode), ResizeModeProperty, BindingMode.OneWay);

Fluent.Ribbon/Themes/Controls/Gallery.xaml

@@ -140,6 +140,7 @@
                                          MaxItemsInRow="{TemplateBinding MaxItemsInRow}"
                                          Filter="{TemplateBinding SelectedFilterGroups}"
                                          GroupBy="{TemplateBinding GroupBy}"
+                                         GroupByAdvanced="{TemplateBinding GroupByAdvanced}"
                                          IsItemsHost="True"
                                          ItemHeight="{TemplateBinding ItemHeight}"
                                          ItemWidth="{TemplateBinding ItemWidth}"

Fluent.Ribbon/Themes/Controls/InRibbonGallery.xaml

@@ -384,6 +384,7 @@
                                                      Orientation="{TemplateBinding Orientation}"
                                                      Filter="{TemplateBinding SelectedFilterGroups}"
                                                      GroupBy="{TemplateBinding GroupBy}"
+                                                     GroupByAdvanced="{TemplateBinding GroupByAdvanced}"
                                                      IsGrouped="False" />
                             </ContentControl>
                             <Image x:Name="PART_FakeImage"