[DYN-7874] As a Dynamo user I do not want the default group description text (#15885)

ivaylo-matov · web-flow · commit 44bcce208b4b · 2025-03-18T11:29:39.000-07:00
diff --git a/src/DynamoCore/Configuration/IPreferences.cs b/src/DynamoCore/Configuration/IPreferences.cs
@@ -20,6 +20,11 @@ public interface IPreferences
         /// </summary>
         bool ShowPreviewBubbles { get; set; }
 
+        /// <summary>
+        /// Indicates if groups should display the default description.
+        /// </summary>
+        public bool ShowDefaultGroupDescription { get; set; }
+
         /// <summary>
         /// Returns height of console
         /// </summary>
diff --git a/src/DynamoCore/Configuration/PreferenceSettings.cs b/src/DynamoCore/Configuration/PreferenceSettings.cs
@@ -185,6 +185,11 @@ public bool IsADPAnalyticsReportingApproved
         /// </summary>
         public bool ShowPreviewBubbles { get; set; }
 
+        /// <summary>
+        /// Indicates if groups should display the default description.
+        /// </summary>
+        public bool ShowDefaultGroupDescription { get; set; }
+
         /// <summary>
         /// Indicates if Host units should be used for graphic helpers for Dynamo Revit
         /// </summary>
@@ -956,6 +961,7 @@ public PreferenceSettings()
             NamespacesToExcludeFromLibrary = new List<string>();
             DefaultRunType = RunType.Automatic;
             DefaultNodeAutocompleteSuggestion = NodeAutocompleteSuggestion.MLRecommendation;
+            ShowDefaultGroupDescription = true;
 
             BackupInterval = DefaultBackupInterval;
             BackupFilesCount = 1;
diff --git a/src/DynamoCore/Models/RecordableCommands.cs b/src/DynamoCore/Models/RecordableCommands.cs
@@ -2251,7 +2251,12 @@ public CreateAnnotationCommand(Guid annotationId, string annotationText, string
                 {
                     annotationText = Resources.GroupNameDefaultText;
                 }
-                if (string.IsNullOrEmpty(annotationDescriptionText))
+
+                if (!PreferenceSettings.Instance.ShowDefaultGroupDescription)
+                {
+                    annotationDescriptionText = string.Empty;
+                }
+                else if (string.IsNullOrEmpty(annotationDescriptionText))
                 {
                     annotationDescriptionText = Resources.GroupDefaultText;
                 }
diff --git a/src/DynamoCore/PublicAPI.Unshipped.txt b/src/DynamoCore/PublicAPI.Unshipped.txt
@@ -242,6 +242,8 @@ Dynamo.Configuration.PreferenceSettings.ShowConnector.get -> bool
 Dynamo.Configuration.PreferenceSettings.ShowConnector.set -> void
 Dynamo.Configuration.PreferenceSettings.ShowConnectorToolTip.get -> bool
 Dynamo.Configuration.PreferenceSettings.ShowConnectorToolTip.set -> void
+Dynamo.Configuration.PreferenceSettings.ShowDefaultGroupDescription.get -> bool
+Dynamo.Configuration.PreferenceSettings.ShowDefaultGroupDescription.set -> void
 Dynamo.Configuration.PreferenceSettings.ShowDetailedLayout.get -> bool
 Dynamo.Configuration.PreferenceSettings.ShowDetailedLayout.set -> void
 Dynamo.Configuration.PreferenceSettings.ShowEdges.get -> bool
@@ -1588,6 +1590,8 @@ Dynamo.Interfaces.IPreferences.Save(string filePath) -> bool
 Dynamo.Interfaces.IPreferences.SetIsBackgroundPreviewActive(string name, bool value) -> void
 Dynamo.Interfaces.IPreferences.ShowConnector.get -> bool
 Dynamo.Interfaces.IPreferences.ShowConnector.set -> void
+Dynamo.Interfaces.IPreferences.ShowDefaultGroupDescription.get -> bool
+Dynamo.Interfaces.IPreferences.ShowDefaultGroupDescription.set -> void
 Dynamo.Interfaces.IPreferences.ShowEdges.get -> bool
 Dynamo.Interfaces.IPreferences.ShowEdges.set -> void
 Dynamo.Interfaces.IPreferences.ShowPreviewBubbles.get -> bool
diff --git a/src/DynamoCoreWpf/Properties/Resources.Designer.cs b/src/DynamoCoreWpf/Properties/Resources.Designer.cs
diff --git a/src/DynamoCoreWpf/Properties/Resources.en-US.resx b/src/DynamoCoreWpf/Properties/Resources.en-US.resx
@@ -2531,7 +2531,7 @@ Do you wish to uninstall {1}? Restart {2} to complete the uninstall and try down
     <comment>Expander Header Name</comment>
   </data>
   <data name="PreferencesViewVisualSettingsGroupStyles" xml:space="preserve">
-    <value>Group Styles</value>
+    <value>Groups</value>
     <comment>Expander Header Name</comment>
   </data>
   <data name="PreferencesViewVisualSettingsRenderPrecision" xml:space="preserve">
@@ -4118,4 +4118,10 @@ To make this file into a new template, save it to a different folder, then move
   <data name="MessageErrorOpeningInvalidPath" xml:space="preserve">
     <value>Invalid file path provided. In case the file is archived, please make sure to extract it before opening.\n{0}</value>
   </data>
+  <data name="PreferencesViewGroupStylesHeader" xml:space="preserve">
+    <value>Group Styles</value>
+  </data>
+  <data name="PreferencesViewShowDefaultGroupDescription" xml:space="preserve">
+    <value>Show default group description</value>
+  </data>
 </root>
diff --git a/src/DynamoCoreWpf/Properties/Resources.resx b/src/DynamoCoreWpf/Properties/Resources.resx
@@ -2816,7 +2816,7 @@ Do you wish to uninstall {1}? Restart {2} to complete the uninstall and try down
     <comment>Expander Header Name</comment>
   </data>
   <data name="PreferencesViewVisualSettingsGroupStyles" xml:space="preserve">
-    <value>Group Styles</value>
+    <value>Groups</value>
     <comment>Expander Header Name</comment>
   </data>
   <data name="PreferencesViewVisualSettingsRenderPrecision" xml:space="preserve">
@@ -4105,4 +4105,10 @@ To make this file into a new template, save it to a different folder, then move
   <data name="MessageErrorOpeningInvalidPath" xml:space="preserve">
     <value>Invalid file path provided. In case the file is archived, please make sure to extract it before opening.\n{0}</value>
   </data>
+  <data name="PreferencesViewGroupStylesHeader" xml:space="preserve">
+    <value>Group Styles</value>
+  </data>
+  <data name="PreferencesViewShowDefaultGroupDescription" xml:space="preserve">
+    <value>Show default group description</value>
+  </data>
 </root>
diff --git a/src/DynamoCoreWpf/PublicAPI.Unshipped.txt b/src/DynamoCoreWpf/PublicAPI.Unshipped.txt
@@ -2248,6 +2248,7 @@ Dynamo.ViewModels.DynamoViewModel.UngroupAnnotationCommand.get -> Dynamo.UI.Comm
 Dynamo.ViewModels.DynamoViewModel.UngroupAnnotationCommand.set -> void
 Dynamo.ViewModels.DynamoViewModel.UngroupModelCommand.get -> Dynamo.UI.Commands.DelegateCommand
 Dynamo.ViewModels.DynamoViewModel.UngroupModelCommand.set -> void
+Dynamo.ViewModels.DynamoViewModel.RefreshAnnotationDescriptions() -> void
 Dynamo.ViewModels.DynamoViewModel.UpdateAllPythonEngineCommand.get -> Dynamo.UI.Commands.DelegateCommand
 Dynamo.ViewModels.DynamoViewModel.UpdateAllPythonEngineCommand.set -> void
 Dynamo.ViewModels.DynamoViewModel.UpdateGraphicHelpersScale(object parameter) -> void
@@ -2884,6 +2885,8 @@ Dynamo.ViewModels.PreferencesViewModel.SelectedUnits.get -> string
 Dynamo.ViewModels.PreferencesViewModel.SelectedUnits.set -> void
 Dynamo.ViewModels.PreferencesViewModel.ShowCodeBlockLineNumber.get -> bool
 Dynamo.ViewModels.PreferencesViewModel.ShowCodeBlockLineNumber.set -> void
+Dynamo.ViewModels.PreferencesViewModel.ShowDefaultGroupDescription.get -> bool
+Dynamo.ViewModels.PreferencesViewModel.ShowDefaultGroupDescription.set -> void
 Dynamo.ViewModels.PreferencesViewModel.ShowEdges.get -> bool
 Dynamo.ViewModels.PreferencesViewModel.ShowEdges.set -> void
 Dynamo.ViewModels.PreferencesViewModel.UseRenderInstancing.get -> bool
@@ -5356,6 +5359,7 @@ static Dynamo.Wpf.Properties.Resources.PreferencesViewGeneralSettingsGeoScaling.
 static Dynamo.Wpf.Properties.Resources.PreferencesViewGeneralSettingsRun.get -> string
 static Dynamo.Wpf.Properties.Resources.PreferencesViewGeneralSettingsTemplate.get -> string
 static Dynamo.Wpf.Properties.Resources.PreferencesViewGeneralTab.get -> string
+static Dynamo.Wpf.Properties.Resources.PreferencesViewGroupStylesHeader.get -> string
 static Dynamo.Wpf.Properties.Resources.PreferencesViewIncludeTimestampExportPathTooltip.get -> string
 static Dynamo.Wpf.Properties.Resources.PreferencesViewLanguageLabel.get -> string
 static Dynamo.Wpf.Properties.Resources.PreferencesViewLanguageSwitchHelp.get -> string
@@ -5372,6 +5376,7 @@ static Dynamo.Wpf.Properties.Resources.PreferencesViewSavedChangesTooltip.get ->
 static Dynamo.Wpf.Properties.Resources.PreferencesViewSelectedPackagePathForDownload.get -> string
 static Dynamo.Wpf.Properties.Resources.PreferencesViewSettingIncludeTimestampExportPath.get -> string
 static Dynamo.Wpf.Properties.Resources.PreferencesViewShowCodeBlockNodeLineNumber.get -> string
+static Dynamo.Wpf.Properties.Resources.PreferencesViewShowDefaultGroupDescription.get -> string
 static Dynamo.Wpf.Properties.Resources.PreferencesViewShowPreviewBubbles.get -> string
 static Dynamo.Wpf.Properties.Resources.PreferencesViewShowRunPreviewTooltip.get -> string
 static Dynamo.Wpf.Properties.Resources.PreferencesViewShowStaticSplashScreenTooltip.get -> string
diff --git a/src/DynamoCoreWpf/UI/Converters.cs b/src/DynamoCoreWpf/UI/Converters.cs
@@ -2842,6 +2842,14 @@ public class AnnotationTextConverter : IValueConverter
         public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
         {
             var text = value == null ? String.Empty : value.ToString();
+
+            bool showDefault = Dynamo.Configuration.PreferenceSettings.Instance.ShowDefaultGroupDescription;
+
+            if (!showDefault && text == Resources.GroupDefaultText)
+            {
+                return string.Empty;
+            }
+
             return text;
         }
 
diff --git a/src/DynamoCoreWpf/ViewModels/Core/DynamoViewModel.cs b/src/DynamoCoreWpf/ViewModels/Core/DynamoViewModel.cs
@@ -2114,6 +2114,10 @@ private void Open(object parameters)
                 RunSettings.ForceBlockRun = displayTrustWarning;
                 // Execute graph open command
                 ExecuteCommand(new DynamoModel.OpenFileCommand(filePath, forceManualMode, isTemplate));
+
+                // Apply annotation updates based on the preference setting
+                RefreshAnnotationDescriptions();
+
                 // Only show trust warning popop when current opened workspace is homeworkspace and not custom node workspace
                 if (displayTrustWarning && (currentWorkspaceViewModel?.IsHomeSpace ?? false))
                 {
@@ -2275,6 +2279,25 @@ private bool CanOpenFromJson(object parameters)
             return PathHelper.isFileContentsValidJson(fileContents, out _);
         }
 
+        /// <summary>
+        /// Forces all annotations in the workspace to refresh their description text,
+        /// ensuring that UI updates when the ShowDefaultGroupDescription setting changes.
+        /// </summary>
+        public void RefreshAnnotationDescriptions()
+        {
+            foreach (var workspace in Model.Workspaces)
+            {
+                if (workspace.Annotations.Any())
+                {
+                    foreach (var group in workspace.Annotations)
+                    {
+                        var temp = group.AnnotationDescriptionText;
+                        group.AnnotationDescriptionText = temp;
+                    }
+                }
+            }
+        }
+
         /// <summary>
         /// Read the contents of the file and set the view parameters for that current workspace
         /// </summary>
diff --git a/src/DynamoCoreWpf/ViewModels/Menu/PreferencesViewModel.cs b/src/DynamoCoreWpf/ViewModels/Menu/PreferencesViewModel.cs
@@ -811,6 +811,24 @@ public bool ShowPreviewBubbles
             }
         }
 
+        /// <summary>
+        /// Indicates if groups should display the default description.
+        /// </summary>
+        public bool ShowDefaultGroupDescription
+        {
+            get
+            {
+                return preferenceSettings.ShowDefaultGroupDescription;
+            }
+            set
+            {
+                preferenceSettings.ShowDefaultGroupDescription = value;
+                RaisePropertyChanged(nameof(ShowDefaultGroupDescription));
+
+                dynamoViewModel.RefreshAnnotationDescriptions();
+            }
+        }
+
         /// <summary>
         /// Indicates if Host units should be used for graphic helpers for Dynamo Revit
         /// Also toggles between Host and Dynamo units 
@@ -1828,6 +1846,9 @@ private void Model_PropertyChanged(object sender, PropertyChangedEventArgs e)
                 case nameof(ShowPreviewBubbles):
                     description = Res.ResourceManager.GetString(nameof(Res.PreferencesViewShowPreviewBubbles), System.Globalization.CultureInfo.InvariantCulture);
                     goto default;
+                case nameof(ShowDefaultGroupDescription):
+                    description = Res.ResourceManager.GetString(nameof(Res.PreferencesViewShowDefaultGroupDescription), System.Globalization.CultureInfo.InvariantCulture);
+                    goto default;
                 case nameof(ShowCodeBlockLineNumber):
                     description = Res.ResourceManager.GetString(nameof(Res.PreferencesViewShowCodeBlockNodeLineNumber), System.Globalization.CultureInfo.InvariantCulture);
                     goto default;
diff --git a/src/DynamoCoreWpf/Views/Menu/PreferencesView.xaml b/src/DynamoCoreWpf/Views/Menu/PreferencesView.xaml
@@ -1198,11 +1198,18 @@
                                             <RowDefinition Height="Auto" />
                                             <RowDefinition Height="Auto" />
                                             <RowDefinition Height="Auto" />
+                                            <RowDefinition Height="Auto" />
+                                            <RowDefinition Height="Auto" />
                                         </Grid.RowDefinitions>
+                                        <Label Grid.Row="0"
+                                               Content="{x:Static p:Resources.PreferencesViewGroupStylesHeader}"
+                                               Margin="-3,0,10,0"
+                                               FontWeight="Bold"
+                                               Foreground="{StaticResource PreferencesWindowFontColor}"/>
                                         <Button x:Name="AddStyleButton"
                                                 Style="{StaticResource SolidButtonStyleSmaller}"      
                                                 HorizontalAlignment="Left"
-                                                Grid.Row="0"
+                                                Grid.Row="1"
                                                 MaxWidth="120"
                                                 MinWidth="100"
                                                 Margin="0,5,0,5"
@@ -1216,7 +1223,7 @@
                                                 MinWidth="335"
                                                 Margin="3,0,72,5"
                                                 Background="{StaticResource PreferencesWindowVisualSettingsAddStyleBackground}"
-                                                Grid.Row="1">
+                                                Grid.Row="2">
                                             <Grid>
                                                 <Grid.RowDefinitions>
                                                     <RowDefinition Height="*"></RowDefinition>
@@ -1290,7 +1297,7 @@
                                                  BorderBrush="Transparent"
                                                  BorderThickness="1"
                                                  Margin="0"
-                                                 Grid.Row="2"
+                                                 Grid.Row="3"
                                                  LostFocus="GroupStylesListBox_LostFocus"
                                                  ItemsSource="{Binding StyleItemsList}"
                                                  ItemTemplate="{StaticResource styleViewItemTemplate}"
@@ -1303,6 +1310,25 @@
                                                 </ItemsPanelTemplate>
                                             </ListBox.ItemsPanel>
                                         </ListBox>
+                                        <Grid Grid.Row="4" Margin="0,5,0,20">
+                                            <Grid>
+                                                <Grid.ColumnDefinitions>
+                                                    <ColumnDefinition Width="Auto"/>
+                                                    <ColumnDefinition Width="Auto"/>
+                                                </Grid.ColumnDefinitions>
+                                                <ToggleButton Width="{StaticResource ToggleButtonWidth}"
+                                                              Height="{StaticResource ToggleButtonHeight}"
+                                                              VerticalAlignment="Center"
+                                                              Margin="2,0,0,0"
+                                                              Grid.Column="0"
+                                                              IsEnabled="True"
+                                                              IsChecked="{Binding Path=ShowDefaultGroupDescription}"
+                                                              Style="{StaticResource EllipseToggleButton1}"/>
+                                                <Label Grid.Column="1"
+                                                       Content="{x:Static p:Resources.PreferencesViewShowDefaultGroupDescription}"
+                                                       Foreground="{StaticResource PreferencesWindowFontColor}"/>
+                                            </Grid>
+                                        </Grid>
                                     </Grid>
                                 </ScrollViewer>
                             </Expander>
diff --git a/test/settings/DynamoSettings-NewSettings.xml b/test/settings/DynamoSettings-NewSettings.xml
@@ -7,6 +7,7 @@
   <ConsoleHeight>123</ConsoleHeight>
   <GraphicScaleUnit>Feet</GraphicScaleUnit>
   <ShowPreviewBubbles>false</ShowPreviewBubbles>
+  <ShowDefaultGroupDescription>false</ShowDefaultGroupDescription>
   <UseHostScaleUnits>false</UseHostScaleUnits>
   <ShowCodeBlockLineNumber>false</ShowCodeBlockLineNumber>
   <ShowConnector>false</ShowConnector>

Original file line number	Diff line number	Diff line change
`@@ -2251,7 +2251,12 @@ public CreateAnnotationCommand(Guid annotationId, string annotationText, string`
`2251`	`2251`	`{`
`2252`	`2252`	`annotationText = Resources.GroupNameDefaultText;`
`2253`	`2253`	`}`
`2254`		`- if (string.IsNullOrEmpty(annotationDescriptionText))`
	`2254`	`+`
	`2255`	`+ if (!PreferenceSettings.Instance.ShowDefaultGroupDescription)`
	`2256`	`+ {`
	`2257`	`+ annotationDescriptionText = string.Empty;`
	`2258`	`+ }`
	`2259`	`+ else if (string.IsNullOrEmpty(annotationDescriptionText))`
`2255`	`2260`	`{`
`2256`	`2261`	`annotationDescriptionText = Resources.GroupDefaultText;`
`2257`	`2262`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2842,6 +2842,14 @@ public class AnnotationTextConverter : IValueConverter`
`2842`	`2842`	`public object Convert(object value, Type targetType, object parameter, CultureInfo culture)`
`2843`	`2843`	`{`
`2844`	`2844`	`var text = value == null ? String.Empty : value.ToString();`
	`2845`	`+`
	`2846`	`+ bool showDefault = Dynamo.Configuration.PreferenceSettings.Instance.ShowDefaultGroupDescription;`
	`2847`	`+`
	`2848`	`+ if (!showDefault && text == Resources.GroupDefaultText)`
	`2849`	`+ {`
	`2850`	`+ return string.Empty;`
	`2851`	`+ }`
	`2852`	`+`
`2845`	`2853`	`return text;`
`2846`	`2854`	`}`
`2847`	`2855`