review usage of string.Format in PresentationFramework

Author: halgab

src/Microsoft.DotNet.Wpf/src/PresentationFramework/MS/Internal/Data/LiveShapingList.cs

@@ -732,9 +732,8 @@ public DependencyProperty GetDP(string path)
                     lock (s_Sync)
                     {
                         dp = DependencyProperty.RegisterAttached(
-                            String.Format(System.Windows.Markup.TypeConverterHelper.InvariantEnglishUS,
-                                            "LiveSortingTargetProperty{0}",
-                                            s_dpList.Count),
+                            string.Create(System.Windows.Markup.TypeConverterHelper.InvariantEnglishUS,
+                                            $"LiveSortingTargetProperty{s_dpList.Count}"),
                             typeof(object),
                             typeof(LiveShapingList));
 

src/Microsoft.DotNet.Wpf/src/PresentationFramework/MS/Internal/Data/ObjectRef.cs

@@ -283,8 +283,7 @@ internal override object GetObject(DependencyObject d, ObjectRefArgs args)
 
         public override string ToString()
         {
-            return String.Format(CultureInfo.InvariantCulture,
-                    "ElementName={0}", _name);
+            return $"ElementName={_name}";
         }
 
         internal override string Identify()
@@ -336,15 +335,11 @@ public override string ToString()
             switch (_relativeSource.Mode)
             {
                 case RelativeSourceMode.FindAncestor:
-                    s = String.Format(CultureInfo.InvariantCulture,
-                        "RelativeSource {0}, AncestorType='{1}', AncestorLevel='{2}'",
-                        _relativeSource.Mode,
-                        _relativeSource.AncestorType,
-                        _relativeSource.AncestorLevel);
+                    s = string.Create(CultureInfo.InvariantCulture,
+                        $"RelativeSource {_relativeSource.Mode}, AncestorType='{_relativeSource.AncestorType}', AncestorLevel='{_relativeSource.AncestorLevel}'");
                     break;
                 default:
-                    s = String.Format(CultureInfo.InvariantCulture,
-                        "RelativeSource {0}", _relativeSource.Mode);
+                    s = string.Create(CultureInfo.InvariantCulture, $"RelativeSource {_relativeSource.Mode}");
                     break;
             }
 
@@ -453,8 +448,8 @@ protected override bool ProtectedUsesMentor
 
         internal override string Identify()
         {
-            return String.Format(System.Windows.Markup.TypeConverterHelper.InvariantEnglishUS,
-                "RelativeSource ({0})", _relativeSource.Mode);
+            return string.Create(System.Windows.Markup.TypeConverterHelper.InvariantEnglishUS,
+                $"RelativeSource ({_relativeSource.Mode})");
         }
 
         //------------------------------------------------------

src/Microsoft.DotNet.Wpf/src/PresentationFramework/MS/Internal/Data/PropertyPathWorker.cs

@@ -1270,16 +1270,13 @@ item is Freezable &&    // subproperty notifications only arise from Freezables
                 StringBuilder sb = new StringBuilder();
 
                 if (!Object.Equals(info, svs.info))
-                    sb.AppendLine(String.Format("  Info is wrong: expected '{0}' got '{1}'",
-                                    info, svs.info));
+                    sb.AppendLine($"  Info is wrong: expected '{info}' got '{svs.info}'");
 
                 if (sourceType != svs.type)
-                    sb.AppendLine(String.Format("  Type is wrong: expected '{0}' got '{1}'",
-                                    sourceType, svs.type));
+                    sb.AppendLine($"  Type is wrong: expected '{sourceType}' got '{svs.type}'");
 
                 if (item != BindingExpression.GetReference(svs.item))
-                    sb.AppendLine(String.Format("  Item is wrong: expected '{0}' got '{1}'",
-                                    item, BindingExpression.GetReference(svs.item)));
+                    sb.AppendLine($"  Item is wrong: expected '{item}' got '{BindingExpression.GetReference(svs.item)}'");
 
                 int len1 = (args != null) ? args.Length : 0;
                 int len2 = (svs.args != null) ? svs.args.Length : 0;
@@ -1289,21 +1286,18 @@ item is Freezable &&    // subproperty notifications only arise from Freezables
                     {
                         if (!Object.Equals(args[i], svs.args[i]))
                         {
-                            sb.AppendLine(String.Format("  args[{0}] is wrong:  expected '{1}' got '{2}'",
-                                    i, args[i], svs.args[i]));
+                            sb.AppendLine($"  args[{i}] is wrong:  expected '{args[i]}' got '{svs.args[i]}'");
                         }
                     }
                 }
                 else
-                    sb.AppendLine(String.Format("  Args are wrong: expected length '{0}' got length '{1}'",
-                                    len1, len2));
+                    sb.AppendLine($"  Args are wrong: expected length '{len1}' got length '{len2}'");
 
-                if (sb.Length > 0)
-                {
-                    Debug.Assert(false,
-                        String.Format("Accessor cache returned incorrect result for ({0},{1},{2})\n{3}",
-                            SVI[k].type, newType.Name, SVI[k].name, sb.ToString()));
-                }
+                Debug.Assert(sb.Length == 0,
+                    $"""
+                     Accessor cache returned incorrect result for ({SVI[k].type},{newType.Name},{SVI[k].name})
+                     {sb.ToString()}
+                     """);
 
                 return;
             }

src/Microsoft.DotNet.Wpf/src/PresentationFramework/MS/Internal/Data/XmlBindingWorker.cs

@@ -551,17 +551,15 @@ private string IdentifyNode(XmlNode node)
             if (node == null)
                 return "<null>";
 
-            return String.Format(TypeConverterHelper.InvariantEnglishUS, "{0} ({1})",
-                                    node.GetType().Name, node.Name);
+            return $"{node.GetType().Name} ({node.Name})";
         }
 
         private string IdentifyNodeList(XmlNodeList nodeList)
         {
             if (nodeList == null)
                 return "<null>";
 
-            return String.Format(TypeConverterHelper.InvariantEnglishUS, "{0} (hash={1} Count={2})",
-                                    nodeList.GetType().Name, AvTrace.GetHashCodeHelper(nodeList), nodeList.Count);
+            return string.Create(TypeConverterHelper.InvariantEnglishUS, $"{nodeList.GetType().Name} (hash={AvTrace.GetHashCodeHelper(nodeList)} Count={nodeList.Count})");
         }
 
         // 90% of the XPaths used in practice are very simple - consisting of a

src/Microsoft.DotNet.Wpf/src/PresentationFramework/MS/Internal/Globalization/BamlTreeMap.cs

@@ -19,9 +19,9 @@
 using MS.Utility;
 
 
-// Disabling 1634 and 1691: 
-// In order to avoid generating warnings about unknown message numbers and 
-// unknown pragmas when compiling C# source code with the C# compiler, 
+// Disabling 1634 and 1691:
+// In order to avoid generating warnings about unknown message numbers and
+// unknown pragmas when compiling C# source code with the C# compiler,
 // you need to disable warnings 1634 and 1691. (Presharp Documentation)
 #pragma warning disable 1634, 1691
 
@@ -82,7 +82,7 @@ internal InternalBamlLocalizabilityResolver Resolver
 
         /// <summary>
         /// Maps a key to a baml tree node in the given tree
-        /// </summary>        
+        /// </summary>
         internal BamlTreeNode MapKeyToBamlTreeNode(BamlLocalizableResourceKey key, BamlTree tree)
         {
             if (_keyToBamlNodeIndexMap.Contains(key))
@@ -95,7 +95,7 @@ internal BamlTreeNode MapKeyToBamlTreeNode(BamlLocalizableResourceKey key, BamlT
 
         /// <summary>
         /// Maps a uid to a baml tree node in the given tree
-        /// </summary>        
+        /// </summary>
         internal BamlStartElementNode MapUidToBamlTreeElementNode(string uid, BamlTree tree)
         {
             if (_uidToBamlNodeIndexMap.Contains(uid))
@@ -126,7 +126,7 @@ internal void EnsureMap()
             {
                 BamlTreeNode currentNode = _tree[i];
 
-                // a node may be marked as unidentifiable if it or its parent has a duplicate uid. 
+                // a node may be marked as unidentifiable if it or its parent has a duplicate uid.
                 if (currentNode.Unidentifiable) continue; // skip unidentifiable nodes
 
                 if (currentNode.NodeType == BamlNodeType.StartElement)
@@ -153,7 +153,7 @@ internal void EnsureMap()
                                     )
                             );
 
-                            // Mark this element and its properties unidentifiable. 
+                            // Mark this element and its properties unidentifiable.
                             currentNode.Unidentifiable = true;
                             if (currentNode.Children != null)
                             {
@@ -164,7 +164,7 @@ internal void EnsureMap()
                                 }
                             }
 
-                            continue; // skip the duplicate node                                
+                            continue; // skip the duplicate node
                         }
                         else
                         {
@@ -179,7 +179,7 @@ internal void EnsureMap()
                      && currentNode.Parent != null
                      && currentNode.Parent.NodeType == BamlNodeType.StartDocument)
                     {
-                        // remember the key to the root element so that 
+                        // remember the key to the root element so that
                         // users can further add modifications to the root that would have a global impact.
                         // such as FlowDirection or CultureInfo
                         _localizableResources.SetRootElementKey(key);
@@ -204,7 +204,7 @@ internal void EnsureMap()
         //-------------------------------------------------
 
         /// <summary>
-        /// Return the localizable resource key for this baml tree node. 
+        /// Return the localizable resource key for this baml tree node.
         /// If this node shouldn't be localized, the key returned will be null.
         /// </summary>
         internal static BamlLocalizableResourceKey GetKey(BamlTreeNode node)
@@ -241,15 +241,11 @@ internal static BamlLocalizableResourceKey GetKey(BamlTreeNode node)
                             }
                             else
                             {
-                                // This node is auto-numbered. This has to do with the fact that 
-                                // the compiler may compile duplicated properties into Baml under the same element. 
-                                uid = string.Format(
+                                // This node is auto-numbered. This has to do with the fact that
+                                // the compiler may compile duplicated properties into Baml under the same element.
+                                uid = string.Create(
                                     TypeConverterHelper.InvariantEnglishUS,
-                                    "{0}.{1}_{2}",
-                                    parent.Uid,
-                                    propertyNode.PropertyName,
-                                    propertyNode.Index
-                                    );
+                                    $"{parent.Uid}.{propertyNode.PropertyName}_{propertyNode.Index}");
                             }
 
                             key = new BamlLocalizableResourceKey(
@@ -310,7 +306,7 @@ internal class InternalBamlLocalizabilityResolver : BamlLocalizabilityResolver
         private Dictionary<string, LocalizabilityAttribute> _propertyAttributeTable;
 
         //
-        // cached localization comments 
+        // cached localization comments
         // Normally, we only need to use comments of a single element at one time.
         // In case of formatting inline tags we might be grabing comments of a few more elements.
         // A small cached would be enough
@@ -398,7 +394,7 @@ internal void ReleaseLocalizabilityCache()
             _commentsDocument = null;
         }
 
-        // Grab the comments on a BamlTreeNode for the value. 
+        // Grab the comments on a BamlTreeNode for the value.
         internal LocalizabilityGroup GetLocalizabilityComment(
             BamlStartElementNode node,
             string localName
@@ -423,7 +419,7 @@ internal string GetStringComment(
             string localName
             )
         {
-            // get all the comments declares on this node            
+            // get all the comments declares on this node
             ElementComments comment = LookupCommentForElement(node);
             for (int i = 0; i < comment.LocalizationComments.Length; i++)
             {
@@ -443,14 +439,14 @@ internal void RaiseErrorNotifyEvent(BamlLocalizerErrorNotifyEventArgs e)
 
         //--------------------------------------
         // BamlLocalizabilityResolver interface
-        //--------------------------------------   
+        //--------------------------------------
         public override ElementLocalizability GetElementLocalizability(string assembly, string className)
         {
             if (_externalResolver == null
               || assembly == null || assembly.Length == 0
               || className == null || className.Length == 0)
             {
-                // return the default value 
+                // return the default value
                 return new ElementLocalizability(
                     null,
                     DefaultAttribute
@@ -616,7 +612,7 @@ private ElementComments LookupCommentForElement(BamlStartElementNode node)
                 //
                 // The baml itself might contain comments too
                 // Grab the missing comments from Baml if there is any.
-                //    
+                //
 
                 for (int i = 0;
                      i < node.Children.Count && (comment.LocalizationComments.Length == 0 || comment.LocalizationAttributes.Length == 0);
@@ -636,14 +632,14 @@ private ElementComments LookupCommentForElement(BamlStartElementNode node)
                         else if (LocComments.IsLocLocalizabilityProperty(propertyNode.OwnerTypeFullName, propertyNode.PropertyName)
                             && comment.LocalizationAttributes.Length == 0)
                         {
-                            // grab comments from Baml                            
+                            // grab comments from Baml
                             SetLocalizationAttributes(node, comment, propertyNode.Value);
                         }
                     }
                 }
             }
 
-            // cached it 
+            // cached it
             _comments[_commentsIndex] = comment;
             _commentsIndex = (_commentsIndex + 1) % _comments.Length;
 
@@ -652,8 +648,8 @@ private ElementComments LookupCommentForElement(BamlStartElementNode node)
 
         private static XmlElement FindElementByID(XmlDocument doc, string uid)
         {
-            // Have considered using XPATH. However, XPATH doesn't have a way to escape single quote within 
-            // single quotes, here we iterate through the document by ourselves            
+            // Have considered using XPATH. However, XPATH doesn't have a way to escape single quote within
+            // single quotes, here we iterate through the document by ourselves
             if (doc != null && doc.DocumentElement != null)
             {
                 foreach (XmlNode node in doc.DocumentElement.ChildNodes)
@@ -722,13 +718,13 @@ string stringComment
         }
 
         /// <summary>
-        /// Data structure for all the comments declared on a particular element 
+        /// Data structure for all the comments declared on a particular element
         /// </summary>
         private class ElementComments
         {
             internal string ElementId;        // element's uid
             internal PropertyComment[] LocalizationAttributes; // Localization.Attributes
-            internal PropertyComment[] LocalizationComments;   // Localization.Comments 
+            internal PropertyComment[] LocalizationComments;   // Localization.Comments
 
             internal ElementComments()
             {