From c32badb75090e8ae13ed2c0b0731c3f00e149063 Mon Sep 17 00:00:00 2001
From: Brant Martin <rexxar-tc@users.noreply.github.com>
Date: Sun, 11 Feb 2018 22:43:22 -0500
Subject: [PATCH] Add support for Category, Name, and Description to
 PropertyGrid using DisplayAttribute

---
 Torch.Server/Views/ConfigControl.xaml |   2 +-
 Torch/Views/PropertyGrid.xaml         |   2 +
 Torch/Views/PropertyGrid.xaml.cs      | 210 ++++++++++++++++----------
 3 files changed, 136 insertions(+), 78 deletions(-)

diff --git a/Torch.Server/Views/ConfigControl.xaml b/Torch.Server/Views/ConfigControl.xaml
index 06ee641..5d80731 100644
--- a/Torch.Server/Views/ConfigControl.xaml
+++ b/Torch.Server/Views/ConfigControl.xaml
@@ -118,7 +118,7 @@
                 </StackPanel>
                 <Button Grid.Row="1" Content="Save Config" Margin="3" Click="Save_OnClick" />
             </Grid>
-            <views:PropertyGrid Grid.Column="1" Margin="3" DataContext="{Binding SessionSettings}" />
+            <views:PropertyGrid Grid.Column="1" Margin="3" DataContext="{Binding SessionSettings}" IgnoreDisplay ="True" />
             <GridSplitter Grid.Column="1" HorizontalAlignment="Left" VerticalAlignment="Stretch" ShowsPreview="True"
                           Width="2" Background="Gray" />
         </Grid>
diff --git a/Torch/Views/PropertyGrid.xaml b/Torch/Views/PropertyGrid.xaml
index 9cdf05a..43d7138 100644
--- a/Torch/Views/PropertyGrid.xaml
+++ b/Torch/Views/PropertyGrid.xaml
@@ -9,6 +9,7 @@
         <Grid.RowDefinitions>
             <RowDefinition Height="Auto"/>
             <RowDefinition/>
+            <RowDefinition Height="Auto"/>
         </Grid.RowDefinitions>
         <Grid Grid.Row="0"> 
             <Grid.ColumnDefinitions>
@@ -19,5 +20,6 @@
             <TextBox Grid.Column="1" Margin="3" TextChanged="UpdateFilter"/>
         </Grid>
         <ScrollViewer Grid.Row="1" x:Name="ScrollViewer"/>
+        <TextBlock x:Name="TbDescription" Grid.Row="2" MinHeight="18" Background="#FFBBB9B9"/>
     </Grid>
 </UserControl>
diff --git a/Torch/Views/PropertyGrid.xaml.cs b/Torch/Views/PropertyGrid.xaml.cs
index a5eca95..278b1b0 100644
--- a/Torch/Views/PropertyGrid.xaml.cs
+++ b/Torch/Views/PropertyGrid.xaml.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections;
 using System.Collections.Generic;
+using System.ComponentModel;
 using System.ComponentModel.DataAnnotations;
 using System.Linq;
 using System.Reflection;
@@ -29,6 +30,14 @@ namespace Torch.Views
     {
         private Dictionary<Type, Grid> _viewCache = new Dictionary<Type, Grid>();
 
+        public static readonly DependencyProperty IgnoreDisplayProperty = DependencyProperty.Register("IgnoreDisplay", typeof(bool), typeof(PropertyGrid));
+
+        public bool IgnoreDisplay
+        {
+            get => (bool)base.GetValue(IgnoreDisplayProperty);
+            set => base.SetValue(IgnoreDisplayProperty, value);
+        }
+
         public PropertyGrid()
         {
             InitializeComponent();
@@ -59,114 +68,161 @@ namespace Torch.Views
             grid.ColumnDefinitions.Add(new ColumnDefinition { Width = new GridLength(2, GridUnitType.Star) });
             grid.ColumnDefinitions.Add(new ColumnDefinition { Width = new GridLength(1, GridUnitType.Star) });
 
-            var curRow = 0;
-            foreach (var property in properties.OrderBy(x => x.Name))
+            var categories = new Dictionary<string, List<PropertyInfo>>();
+            var descriptors = new Dictionary<PropertyInfo, DisplayAttribute>(properties.Length);
+
+            foreach (var property in properties)
             {
-                if (property.GetGetMethod() == null)
-                    continue;
+                var a = property.GetCustomAttribute<DisplayAttribute>();
+                if (IgnoreDisplay)
+                    a = null;
+                descriptors[property] = a;
+                string category = a?.GroupName ?? "Misc";
 
+                if (!categories.TryGetValue(category, out List<PropertyInfo> l))
+                {
+                    l = new List<PropertyInfo>();
+                    categories[category] = l;
+                }
+                l.Add(property);
+            }
+
+            var curRow = 0;
+            foreach (var c in categories.OrderBy(x => x.Key))
+            {
                 grid.RowDefinitions.Add(new RowDefinition());
+                var cl = new TextBlock
+                         {
+                             Text = c.Key,
+                             VerticalAlignment = VerticalAlignment.Center
+                         };
+                cl.SetValue(Grid.ColumnProperty, 0);
+                cl.SetValue(Grid.ColumnSpanProperty, 2);
+                cl.SetValue(Grid.RowProperty, curRow);
+                cl.Margin = new Thickness(3);
+                cl.FontWeight = FontWeights.Bold;
+                grid.Children.Add(cl);
+                curRow++;
 
-                var displayName = property.GetCustomAttribute<DisplayAttribute>()?.Name;
-                var propertyType = property.PropertyType;
+                c.Value.Sort((a,b)=> string.Compare((descriptors[a]?.Name ?? a.Name), descriptors[b]?.Name ?? b.Name, StringComparison.Ordinal));
 
-                var text = new TextBlock
+                foreach (var property in c.Value)
                 {
-                    Text = property.Name,
-                    ToolTip = displayName,
-                    VerticalAlignment = VerticalAlignment.Center
-                };
-                text.SetValue(Grid.ColumnProperty, 0);
-                text.SetValue(Grid.RowProperty, curRow);
-                text.Margin = new Thickness(3);
-                grid.Children.Add(text);
+                    if (property.GetGetMethod() == null)
+                        continue;
 
-                FrameworkElement valueControl;
-                if (property.GetSetMethod() == null)
-                {
-                    valueControl = new TextBlock();
-                    var binding = new Binding(property.Name)
+                    grid.RowDefinitions.Add(new RowDefinition());
+
+                    var descriptor = descriptors[property];
+                    var displayName = descriptor?.Name;
+                    var propertyType = property.PropertyType;
+
+                    var text = new TextBlock
+                               {
+                                   Text = displayName ?? property.Name,
+                                   ToolTip = displayName,
+                                   VerticalAlignment = VerticalAlignment.Center
+                               };
+                    text.SetValue(Grid.ColumnProperty, 0);
+                    text.SetValue(Grid.RowProperty, curRow);
+                    text.Margin = new Thickness(3);
+                    text.Tag = $"{text.Text}: {descriptor?.Description}";
+                    text.IsMouseDirectlyOverChanged += Text_IsMouseDirectlyOverChanged;
+                    grid.Children.Add(text);
+
+                    FrameworkElement valueControl;
+                    if (property.GetSetMethod() == null)
                     {
-                        Mode = BindingMode.OneWay
-                    };
-                    valueControl.SetBinding(TextBlock.TextProperty, binding);
-                }
-                else if (propertyType == typeof(bool) || propertyType == typeof(bool?))
-                {
-                    valueControl = new CheckBox();
-                    valueControl.SetBinding(CheckBox.IsCheckedProperty, property.Name);
-                }
-                else if (propertyType.IsEnum)
-                {
-                    valueControl = new ComboBox
+                        valueControl = new TextBlock();
+                        var binding = new Binding(property.Name)
+                                      {
+                                          Mode = BindingMode.OneWay
+                                      };
+                        valueControl.SetBinding(TextBlock.TextProperty, binding);
+                    }
+                    else if (propertyType == typeof(bool) || propertyType == typeof(bool?))
                     {
-                        ItemsSource = Enum.GetValues(property.PropertyType)
-                    };
-                    valueControl.SetBinding(ComboBox.SelectedItemProperty, property.Name);
-                }
-                else if (propertyType.IsGenericType && propertyType.GetGenericTypeDefinition() == typeof(Dictionary<,>))
-                {
-                    var button = new Button
+                        valueControl = new CheckBox();
+                        valueControl.SetBinding(CheckBox.IsCheckedProperty, property.Name);
+                    }
+                    else if (propertyType.IsEnum)
                     {
-                        Content = "Edit Collection"
-                    };
-                    button.SetBinding(Button.DataContextProperty, property.Name);
-                    button.Click += (sender, args) => EditDictionary(((Button)sender).DataContext);
+                        valueControl = new ComboBox
+                                       {
+                                           ItemsSource = Enum.GetValues(property.PropertyType)
+                                       };
+                        valueControl.SetBinding(ComboBox.SelectedItemProperty, property.Name);
+                    }
+                    else if (propertyType.IsGenericType && propertyType.GetGenericTypeDefinition() == typeof(Dictionary<,>))
+                    {
+                        var button = new Button
+                                     {
+                                         Content = "Edit Collection"
+                                     };
+                        button.SetBinding(Button.DataContextProperty, property.Name);
+                        button.Click += (sender, args) => EditDictionary(((Button)sender).DataContext);
 
-                    valueControl = button;
-                }
-                else if (propertyType.IsGenericType && propertyType.GetGenericTypeDefinition() == typeof(SerializableDictionary<,>))
-                {
-                    var button = new Button
+                        valueControl = button;
+                    }
+                    else if (propertyType.IsGenericType && propertyType.GetGenericTypeDefinition() == typeof(SerializableDictionary<,>))
                     {
-                        Content = "Edit Collection"
-                    };
-                    button.SetBinding(Button.DataContextProperty, $"{property.Name}.Dictionary");
-                    button.Click += (sender, args) => EditDictionary(((Button)sender).DataContext);
+                        var button = new Button
+                                     {
+                                         Content = "Edit Collection"
+                                     };
+                        button.SetBinding(Button.DataContextProperty, $"{property.Name}.Dictionary");
+                        button.Click += (sender, args) => EditDictionary(((Button)sender).DataContext);
 
-                    valueControl = button;
-                }
-                else if (propertyType.IsGenericType && typeof(ICollection).IsAssignableFrom(propertyType.GetGenericTypeDefinition()))
-                {
+                        valueControl = button;
+                    }
+                    else if (propertyType.IsGenericType && typeof(ICollection).IsAssignableFrom(propertyType.GetGenericTypeDefinition()))
+                    {
                         var button = new Button
                                      {
                                          Content = "Edit Collection"
                                      };
                         button.SetBinding(Button.DataContextProperty, $"{property.Name}");
 
-                    var gt = propertyType.GetGenericArguments()[0];
-                    
-                    //TODO: Is this the best option? Probably not
-                    if (gt.IsPrimitive || gt == typeof(string))
-                    {
-                        button.Click += (sender, args) => EditPrimitiveCollection(((Button)sender).DataContext);
+                        var gt = propertyType.GetGenericArguments()[0];
+
+                        //TODO: Is this the best option? Probably not
+                        if (gt.IsPrimitive || gt == typeof(string))
+                        {
+                            button.Click += (sender, args) => EditPrimitiveCollection(((Button)sender).DataContext);
+                        }
+                        else
+                        {
+                            button.Click += (sender, args) => EditObjectCollection(((Button)sender).DataContext);
+                        }
+
+                        valueControl = button;
                     }
                     else
                     {
-                        button.Click += (sender, args) => EditObjectCollection(((Button)sender).DataContext);
+                        valueControl = new TextBox();
+                        valueControl.SetBinding(TextBox.TextProperty, property.Name);
                     }
 
-                    valueControl = button;
-                }
-                else
-                {
-                    valueControl = new TextBox();
-                    valueControl.SetBinding(TextBox.TextProperty, property.Name);
-                }
+                    valueControl.Margin = new Thickness(3);
+                    valueControl.VerticalAlignment = VerticalAlignment.Center;
+                    valueControl.SetValue(Grid.ColumnProperty, 1);
+                    valueControl.SetValue(Grid.RowProperty, curRow);
+                    valueControl.IsMouseDirectlyOverChanged += Text_IsMouseDirectlyOverChanged;
+                    grid.Children.Add(valueControl);
 
-                valueControl.Margin = new Thickness(3);
-                valueControl.VerticalAlignment = VerticalAlignment.Center;
-                valueControl.SetValue(Grid.ColumnProperty, 1);
-                valueControl.SetValue(Grid.RowProperty, curRow);
-                grid.Children.Add(valueControl);
-
-                curRow++;
+                    curRow++;
+                }
             }
 
             _viewCache.Add(t, grid);
             return grid;
         }
 
+        private void Text_IsMouseDirectlyOverChanged(object sender, DependencyPropertyChangedEventArgs e)
+        {
+            TbDescription.Text = (sender as FrameworkElement)?.Tag?.ToString() ?? string.Empty;
+        }
+
         private void EditDictionary(object dict)
         {
             var dic = (IDictionary)dict;