Fix for reload of comment formatting options not triggering a UI refresh. Use reflection and echo property change notices for all public properties on internal options object.

Author: codecadwallader

CodeMaid/UI/Dialogs/Options/Formatting/FormattingDataTemplate.xaml

@@ -7,28 +7,27 @@
                 <StackPanel>
                     <StackPanel Orientation="Horizontal">
                         <TextBlock Text="Wrap comments at column" VerticalAlignment="Center" />
-                        <TextBox Text="{Binding CommentWrapColumn, UpdateSourceTrigger=PropertyChanged}" TextAlignment="Right" Width="40" />
+                        <TextBox Text="{Binding WrapAtColumn, UpdateSourceTrigger=PropertyChanged}" TextAlignment="Right" Width="40" />
                     </StackPanel>
 
-                    <CheckBox Content="Skip wrapping on the last word" IsChecked="{Binding CommentSkipWrapOnLastWord}" />
+                    <CheckBox Content="Skip wrapping on the last word" IsChecked="{Binding SkipWrapOnLastWord}" />
 
                     <StackPanel Orientation="Horizontal">
                         <TextBlock Text="Extra indent for values inside XML comments" VerticalAlignment="Center" />
-                        <TextBox Text="{Binding CommentXmlValueIndent, UpdateSourceTrigger=PropertyChanged}" TextAlignment="Right" Width="40" />
+                        <TextBox Text="{Binding XmlValueIndent, UpdateSourceTrigger=PropertyChanged}" TextAlignment="Right" Width="40" />
                     </StackPanel>
 
-                    <CheckBox Content="Add spacing around XML tags" IsChecked="{Binding CommentXmlSpaceTags}" />
-                    <CheckBox Content="Add space inside self closing tags" IsChecked="{Binding CommentXmlSpaceSingleTags}" />
-                    <CheckBox Content="Keep XML tags together" IsChecked="{Binding CommentXmlKeepTagsTogether}" />
-                    <CheckBox Content="Align XML &lt;param&gt; tags" IsChecked="{Binding CommentXmlAlignParamTags}" />
-                    <CheckBox Content="Always split &lt;summary&gt; tags onto multiple lines" IsChecked="{Binding CommentXmlSplitSummaryTagToMultipleLines}" />
-                    <CheckBox Content="Always split all XML tags onto multiple lines" IsChecked="{Binding CommentXmlSplitAllTags}" />
-
+                    <CheckBox Content="Add spacing around XML tags" IsChecked="{Binding XmlSpaceTagContent}" />
+                    <CheckBox Content="Add space inside self closing tags" IsChecked="{Binding XmlSpaceSingleTags}" />
+                    <CheckBox Content="Keep XML tags together" IsChecked="{Binding XmlKeepTagsTogether}" />
+                    <CheckBox Content="Align XML &lt;param&gt; tags" IsChecked="{Binding XmlAlignParamTags}" />
+                    <CheckBox Content="Always split &lt;summary&gt; tags onto multiple lines" IsChecked="{Binding XmlSplitSummaryTag}" />
+                    <CheckBox Content="Always split all XML tags onto multiple lines" IsChecked="{Binding XmlSplitAllTags}" />
                 </StackPanel>
             </GroupBox>
 
             <GroupBox Header="Cleanup">
-                <CheckBox Content="Run format comments during cleanup" IsChecked="{Binding CommentRunDuringCleanup}" />
+                <CheckBox Content="Run format comments during cleanup" IsChecked="{Binding FormatDuringCleanup}" />
             </GroupBox>
 
             <GroupBox Header="Preview" VerticalAlignment="Stretch">

CodeMaid/UI/Dialogs/Options/Formatting/FormattingViewModel.cs

@@ -72,6 +72,7 @@ public override void LoadSettings()
         {
             _options = new CodeCommentOptions(Settings.Default, 4);
 
+            RaisePropertyChangedForAllOptionsProperties();
             UpdatePreviewText();
         }
 
@@ -90,7 +91,7 @@ public override void SaveSettings()
         /// <summary>
         /// Gets or sets the flag indicating if comment formatting will run during cleanup.
         /// </summary>
-        public bool CommentRunDuringCleanup
+        public bool FormatDuringCleanup
         {
             get { return _options.FormatDuringCleanup; }
             set
@@ -106,7 +107,7 @@ public bool CommentRunDuringCleanup
         /// <summary>
         /// Gets or sets the flag indicating if comment formatting should skip wrapping the last word.
         /// </summary>
-        public bool CommentSkipWrapOnLastWord
+        public bool SkipWrapOnLastWord
         {
             get { return _options.SkipWrapOnLastWord; }
             set
@@ -122,7 +123,7 @@ public bool CommentSkipWrapOnLastWord
         /// <summary>
         /// Gets or sets the column where comments will attempt to wrap.
         /// </summary>
-        public int CommentWrapColumn
+        public int WrapAtColumn
         {
             get { return _options.WrapAtColumn; }
             set
@@ -139,7 +140,7 @@ public int CommentWrapColumn
         /// <summary>
         /// Gets or sets the flag indicating if the content of param tags should be aligned.
         /// </summary>
-        public bool CommentXmlAlignParamTags
+        public bool XmlAlignParamTags
         {
             get { return _options.XmlAlignParamTags; }
             set
@@ -155,7 +156,7 @@ public bool CommentXmlAlignParamTags
         /// <summary>
         /// Gets or sets the flag indicating if an extra space should be added inside XML tags.
         /// </summary>
-        public bool CommentXmlSpaceTags
+        public bool XmlSpaceTagContent
         {
             get { return _options.XmlSpaceTagContent; }
             set
@@ -171,7 +172,7 @@ public bool CommentXmlSpaceTags
         /// <summary>
         /// Gets or sets the flag indicating if summary tags should always be split to multiple lines.
         /// </summary>
-        public bool CommentXmlSplitSummaryTagToMultipleLines
+        public bool XmlSplitSummaryTag
         {
             get { return _options.XmlSplitSummaryTag; }
             set
@@ -187,7 +188,7 @@ public bool CommentXmlSplitSummaryTagToMultipleLines
         /// <summary>
         /// Gets or sets the amount of extra spacing to add before XML values.
         /// </summary>
-        public int CommentXmlValueIndent
+        public int XmlValueIndent
         {
             get { return _options.XmlValueIndent; }
             set
@@ -201,7 +202,7 @@ public int CommentXmlValueIndent
             }
         }
 
-        public bool CommentXmlTagsToLowerCase
+        public bool XmlTagsToLowerCase
         {
             get { return _options.XmlTagsToLowerCase; }
             set
@@ -214,7 +215,7 @@ public bool CommentXmlTagsToLowerCase
             }
         }
 
-        public bool CommentXmlSpaceSingleTags
+        public bool XmlSpaceSingleTags
         {
             get { return _options.XmlSpaceSingleTags; }
             set
@@ -227,7 +228,7 @@ public bool CommentXmlSpaceSingleTags
             }
         }
 
-        public bool CommentXmlKeepTagsTogether
+        public bool XmlKeepTagsTogether
         {
             get { return _options.XmlKeepTagsTogether; }
             set
@@ -240,7 +241,7 @@ public bool CommentXmlKeepTagsTogether
             }
         }
 
-        public bool CommentXmlSplitAllTags
+        public bool XmlSplitAllTags
         {
             get { return _options.XmlSplitAllTags; }
             set
@@ -253,6 +254,24 @@ public bool CommentXmlSplitAllTags
             }
         }
 
+        /// <summary>
+        /// Calls <see cref="Bindable.RaisePropertyChanged"/> for every public property exposed on
+        /// the <see cref="CodeCommentOptions"/> class. This ensures that changes to that class
+        /// (which do not raise events) will be bubbled up to the UI correctly.
+        /// </summary>
+        /// <remarks>
+        /// Note: For this to work properly, the wrapping property on this view model must match the
+        ///       name of the underlying property within the options class.
+        /// </remarks>
+        private void RaisePropertyChangedForAllOptionsProperties()
+        {
+            var optionsProperties = _options.GetType().GetProperties();
+            foreach (var optionsProperty in optionsProperties)
+            {
+                RaisePropertyChanged(optionsProperty.Name);
+            }
+        }
+
         #endregion Options
 
         #region Preview Text and Helpers