Merge branch 'spellCheck' of https://github.com/Keboo/MaterialDesignInXamlToolkit

Author: ButchersBoy

MainDemo.Wpf/TextFields.xaml

@@ -90,6 +90,7 @@
                  MinWidth="280"
                  AcceptsReturn="True"                 
                  VerticalScrollBarVisibility="Auto"
+                 SpellCheck.IsEnabled="True"
                  materialDesign:HintAssist.Hint="Multiline text"
                  Height="80">Multiline.  Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. The quick brown fox jumps over the lazy dog. War and peace. Keep going. Go on. For how long? Not long. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</TextBox>
         <materialDesign:PackIcon Grid.Row="2" Grid.Column="0" Kind="Phone" Foreground="{Binding ElementName=PhoneTextBox, Path=BorderBrush}" />

MaterialDesignThemes.Wpf/MaterialDesignThemes.Wpf.csproj

@@ -329,6 +329,7 @@
     <Compile Include="SnackbarMessageEventArgs.cs" />
     <Compile Include="SnackbarMessageQueue.cs" />
     <Compile Include="SnackbarMessageQueueItem.cs" />
+    <Compile Include="Spelling.cs" />
     <Compile Include="Transitions\CircleWipe.cs" />
     <Compile Include="IHintProxy.cs" />
     <Compile Include="Transitions\FadeWipe.cs" />

MaterialDesignThemes.Wpf/Spelling.cs

@@ -0,0 +1,20 @@
+using System.Windows;
+
+namespace MaterialDesignThemes.Wpf
+{
+    public static class Spelling
+    {
+        public static ResourceKey SpellingSuggestionMenuItemStyleKey { get; } = new ComponentResourceKey(typeof(Spelling), ResourceKeyId.SpellingSuggestionMenuItemStyle);
+        public static ResourceKey SpellingIgnoreAllMenuItemStyleKey { get; } = new ComponentResourceKey(typeof(Spelling), ResourceKeyId.SpellingIgnoreAllMenuItemStyle);
+        public static ResourceKey SpellingNoSuggestionsMenuItemStyleKey { get; } = new ComponentResourceKey(typeof(Spelling), ResourceKeyId.SpellingNoSuggestionsMenuItemStyle);
+        public static ResourceKey SpellingSeparatorStyleKey { get; } = new ComponentResourceKey(typeof(Spelling), ResourceKeyId.SpellingSeparatorStyle);
+    }
+
+    internal enum ResourceKeyId
+    {
+        SpellingSuggestionMenuItemStyle,
+        SpellingIgnoreAllMenuItemStyle,
+        SpellingNoSuggestionsMenuItemStyle,
+        SpellingSeparatorStyle,
+    }
+}

MaterialDesignThemes.Wpf/TextFieldAssist.cs

@@ -1,8 +1,8 @@
-using System;
+using System.Linq;
 using System.Windows;
 using System.Windows.Controls;
 using System.Windows.Controls.Primitives;
-using System.Windows.Media;
+using System.Windows.Documents;
 
 namespace MaterialDesignThemes.Wpf
 {
@@ -47,7 +47,7 @@ public static Thickness GetTextBoxViewMargin(DependencyObject element)
         /// Controls the visibility of the underline decoration.
         /// </summary>
         public static readonly DependencyProperty DecorationVisibilityProperty = DependencyProperty.RegisterAttached(
-            "DecorationVisibility", typeof (Visibility), typeof (TextFieldAssist), new PropertyMetadata(default(Visibility)));
+            "DecorationVisibility", typeof(Visibility), typeof(TextFieldAssist), new PropertyMetadata(default(Visibility)));
 
         /// <summary>
         /// Controls the visibility of the underline decoration.
@@ -64,9 +64,140 @@ public static void SetDecorationVisibility(DependencyObject element, Visibility
         /// <returns></returns>
         public static Visibility GetDecorationVisibility(DependencyObject element)
         {
-            return (Visibility) element.GetValue(DecorationVisibilityProperty);
+            return (Visibility)element.GetValue(DecorationVisibilityProperty);
         }
-        
+
+        /// <summary>
+        /// Automatially inserts spelling suggestions into the text box context menu.
+        /// </summary>
+        public static readonly DependencyProperty IncludeSpellingSuggestionsProperty = DependencyProperty.RegisterAttached(
+            "IncludeSpellingSuggestions", typeof(bool), typeof(TextFieldAssist), new PropertyMetadata(default(bool), IncludeSpellingSuggestionsChanged));
+
+        public static void SetIncludeSpellingSuggestions(TextBoxBase element, bool value)
+        {
+            element.SetValue(IncludeSpellingSuggestionsProperty, value);
+        }
+
+        public static bool GetIncludeSpellingSuggestions(TextBoxBase element)
+        {
+            return (bool)element.GetValue(IncludeSpellingSuggestionsProperty);
+        }
+
+        private static void IncludeSpellingSuggestionsChanged(DependencyObject element, DependencyPropertyChangedEventArgs e)
+        {
+            var textBox = element as TextBoxBase;
+            if (textBox != null)
+            {
+                if ((bool)e.NewValue)
+                {
+                    textBox.ContextMenuOpening += TextBoxOnContextMenuOpening;
+                    textBox.ContextMenuClosing += TextBoxOnContextMenuClosing;
+                }
+                else
+                {
+                    textBox.ContextMenuOpening -= TextBoxOnContextMenuOpening;
+                    textBox.ContextMenuClosing -= TextBoxOnContextMenuClosing;
+                }
+            }
+        }
+
+        private static void TextBoxOnContextMenuOpening(object sender, ContextMenuEventArgs e)
+        {
+            var textBoxBase = sender as TextBoxBase;
+
+            ContextMenu contextMenu = textBoxBase?.ContextMenu;
+            if (contextMenu == null) return;
+
+            RemoveSpellingSuggestions(contextMenu);
+
+            if (!SpellCheck.GetIsEnabled(textBoxBase)) return;
+
+            SpellingError spellingError = GetSpellingError(textBoxBase);
+            if (spellingError != null)
+            {
+                Style spellingSuggestionStyle =
+                    contextMenu.TryFindResource(Spelling.SpellingSuggestionMenuItemStyleKey) as Style;
+
+                int insertionIndex = 0;
+                bool hasSuggestion = false;
+                foreach (string suggestion in spellingError.Suggestions)
+                {
+                    hasSuggestion = true;
+                    var menuItem = new MenuItem
+                    {
+                        CommandTarget = textBoxBase,
+                        Command = EditingCommands.CorrectSpellingError,
+                        CommandParameter = suggestion,
+                        Style = spellingSuggestionStyle,
+                        Tag = typeof(Spelling)
+                    };
+                    contextMenu.Items.Insert(insertionIndex++, menuItem);
+                }
+                if (!hasSuggestion)
+                {
+                    contextMenu.Items.Insert(insertionIndex++, new MenuItem
+                    {
+                        Style = contextMenu.TryFindResource(Spelling.SpellingNoSuggestionsMenuItemStyleKey) as Style,
+                        Tag = typeof(Spelling)
+                    });
+                }
+
+                contextMenu.Items.Insert(insertionIndex++, new Separator
+                {
+                    Style = contextMenu.TryFindResource(Spelling.SpellingSeparatorStyleKey) as Style,
+                    Tag = typeof(Spelling)
+                });
+
+                contextMenu.Items.Insert(insertionIndex++, new MenuItem
+                {
+                    Command = EditingCommands.IgnoreSpellingError,
+                    CommandTarget = textBoxBase,
+                    Style = contextMenu.TryFindResource(Spelling.SpellingIgnoreAllMenuItemStyleKey) as Style,
+                    Tag = typeof(Spelling)
+                });
+
+                contextMenu.Items.Insert(insertionIndex, new Separator
+                {
+                    Style = contextMenu.TryFindResource(Spelling.SpellingSeparatorStyleKey) as Style,
+                    Tag = typeof(Spelling)
+                });
+            }
+        }
+
+        private static SpellingError GetSpellingError(TextBoxBase textBoxBase)
+        {
+            var textBox = textBoxBase as TextBox;
+            if (textBox != null)
+            {
+                return textBox.GetSpellingError(textBox.CaretIndex);
+            }
+            var richTextBox = textBoxBase as RichTextBox;
+            if (richTextBox != null)
+            {
+                return richTextBox.GetSpellingError(richTextBox.CaretPosition);
+            }
+            return null;
+        }
+
+        private static void TextBoxOnContextMenuClosing(object sender, ContextMenuEventArgs e)
+        {
+            var contextMenu = (sender as TextBoxBase)?.ContextMenu;
+            if (contextMenu != null)
+            {
+                RemoveSpellingSuggestions(contextMenu);
+            }
+        }
+
+        private static void RemoveSpellingSuggestions(ContextMenu menu)
+        {
+            foreach (FrameworkElement item in (from item in menu.Items.OfType<FrameworkElement>()
+                                     where ReferenceEquals(item.Tag, typeof(Spelling))
+                                     select item).ToList())
+            {
+                menu.Items.Remove(item);
+            }
+        }
+
         #region Methods
 
         /// <summary>
@@ -84,7 +215,7 @@ private static void ApplyTextBoxViewMargin(Control textBox, Thickness margin)
             var frameworkElement = (textBox.Template.FindName("PART_ContentHost", textBox) as ScrollViewer)?.Content as FrameworkElement;
             if (frameworkElement != null)
             {
-                frameworkElement.Margin = margin;                
+                frameworkElement.Margin = margin;
             }
         }
 
@@ -105,12 +236,12 @@ private static void TextBoxViewMarginPropertyChangedCallback(
 
             if (box.IsLoaded)
             {
-                ApplyTextBoxViewMargin(box, (Thickness) dependencyPropertyChangedEventArgs.NewValue);
+                ApplyTextBoxViewMargin(box, (Thickness)dependencyPropertyChangedEventArgs.NewValue);
             }
 
             box.Loaded += (sender, args) =>
             {
-                var textBox = (Control) sender;
+                var textBox = (Control)sender;
                 ApplyTextBoxViewMargin(textBox, GetTextBoxViewMargin(textBox));
             };
         }

MaterialDesignThemes.Wpf/Themes/MaterialDesignTheme.Menu.xaml

@@ -274,4 +274,18 @@
             </Setter.Value>
         </Setter>
     </Style>
+
+    <Style x:Key="{x:Static wpf:Spelling.SpellingSuggestionMenuItemStyleKey}"  TargetType="{x:Type MenuItem}" BasedOn="{StaticResource MaterialDesignMenuItem}">
+        <Setter Property="FontWeight" Value="Bold" />
+        <Setter Property="Header" Value="{Binding RelativeSource={RelativeSource Self}, Path=CommandParameter}" />
+    </Style>
+
+    <Style x:Key="{x:Static wpf:Spelling.SpellingIgnoreAllMenuItemStyleKey}"  TargetType="{x:Type MenuItem}" BasedOn="{StaticResource MaterialDesignMenuItem}">
+        <Setter Property="Header" Value="Ignore All" />
+    </Style>
+
+    <Style x:Key="{x:Static wpf:Spelling.SpellingNoSuggestionsMenuItemStyleKey}" TargetType="{x:Type MenuItem}" BasedOn="{StaticResource MaterialDesignMenuItem}">
+        <Setter Property="Header" Value="(no spelling suggestions)" />
+        <Setter Property="IsEnabled" Value="False" />
+    </Style>
 </ResourceDictionary>

MaterialDesignThemes.Wpf/Themes/MaterialDesignTheme.TextBox.xaml

@@ -24,6 +24,7 @@
         <Setter Property="ScrollViewer.PanningMode" Value="VerticalFirst"/>
         <Setter Property="Stylus.IsFlicksEnabled" Value="False"/>
         <Setter Property="Validation.ErrorTemplate" Value="{StaticResource MaterialDesignValidationErrorTemplate}"/>
+        <Setter Property="wpf:TextFieldAssist.IncludeSpellingSuggestions" Value="{Binding RelativeSource={RelativeSource Self}, Path=(SpellCheck.IsEnabled)}" />
         <!-- cludge the default context menu -->
         <Setter Property="ContextMenu">
             <Setter.Value>