Prefer use of interpolated strings in PresentationUI and ReachFramework #8739

halgab · 2024-01-28T20:57:24Z

Follow-up to #8519

Description

We replace as many manual string concatenations and string.Format with interpolated strings. This saves allocations in many instances, and makes for a more readable code.

Customer Impact

Less allocations

Regression

No

Testing

CI

Risk

Low. Most changes are automated using the IDE

Microsoft Reviewers: Open in CodeFlow

src/Microsoft.DotNet.Wpf/src/PresentationUI/MS/Internal/Documents/Application/DocumentStream.cs

src/Microsoft.DotNet.Wpf/src/PresentationUI/MS/Internal/Documents/SignatureResourceHelper.cs

dipeshmsft · 2024-08-27T09:13:09Z

src/Microsoft.DotNet.Wpf/src/ReachFramework/Serialization/ColorTypeConverter.cs

-                sb.AppendFormat(provider, "ContextColor {0} ", uriString);
-                sb.AppendFormat(provider, "{1:R}{0}", separator, color.ScA);
-                for (int i = 0; i < color.GetNativeColorValues().GetLength(0); ++i)
+                sb.AppendFormat(provider, $"ContextColor {uriString} ");


This method should be replaced with sb.Append right ?

dipeshmsft · 2024-08-27T09:22:10Z

src/Microsoft.DotNet.Wpf/src/ReachFramework/Packaging/XpsFixedDocumentReaderWriter.cs

-                        "<LinkTarget Name=\"{0}\" />",
-                        nameElement)
-                        );
+                     xmlWriter.WriteRaw($"<LinkTarget Name=\"{nameElement}\" />");


InvariantCulture missing here

dipeshmsft · 2024-08-27T09:24:20Z

src/Microsoft.DotNet.Wpf/src/ReachFramework/Packaging/XpsManager.cs

-                 uniqueUri = String.Format(System.Globalization.CultureInfo.InvariantCulture,
-                                          "{0}.fdseq",
-                                          new object[] { contentKey });
+                 uniqueUri = $"{contentKey}.fdseq";


InvariantCulture missing here

dipeshmsft · 2024-08-27T10:20:22Z

src/Microsoft.DotNet.Wpf/src/ReachFramework/PrintConfig/PrintSchema.cs

-                    " xmlns:" + PrintSchemaPrefixes.xsd + "=\"" + PrintSchemaNamespaces.xsd + "\"" +
-                    " version=\"1\">" +
-                "</" + PrintSchemaPrefixes.Framework + ":" + PrintSchemaTags.Framework.PrintTicketRoot + ">";
+            internal const string EmptyPrintTicket = $"<?xml version=\"1.0\" encoding=\"UTF-8\"?><{PrintSchemaPrefixes.Framework}:{PrintSchemaTags.Framework.PrintTicketRoot} xmlns:{PrintSchemaPrefixes.Framework}=\"{PrintSchemaNamespaces.Framework}\" xmlns:{PrintSchemaPrefixes.StandardKeywordSet}=\"{PrintSchemaNamespaces.StandardKeywordSet}\" xmlns:{PrintSchemaPrefixes.xsi}=\"{PrintSchemaNamespaces.xsi}\" xmlns:{PrintSchemaPrefixes.xsd}=\"{PrintSchemaNamespaces.xsd}\" version=\"1\"></{PrintSchemaPrefixes.Framework}:{PrintSchemaTags.Framework.PrintTicketRoot}>";


It would be better to use string.Concat or the original way here. IMO, this string is too long for using interpolation.

dipeshmsft · 2024-08-27T10:37:09Z

...rosoft.DotNet.Wpf/src/PresentationUI/MS/Internal/Documents/RightsManagementResourceHelper.cs

-                    string resourceName = "PUIRMStatus"
-                        + Enum.GetName(typeof(RightsManagementStatus), status)
-                        + "BrushKey";
+                    string resourceName = $"PUIRMStatus{Enum.GetName(status)}BrushKey";


Is this right ? Enum.GetName ?

dipeshmsft · 2024-08-27T11:56:15Z

src/Microsoft.DotNet.Wpf/src/PresentationUI/MS/Internal/Documents/SignatureResourceHelper.cs

-                    string resourceName = "PUISignatureStatus"
-                        + Enum.GetName(typeof(SignatureStatus), sigStatus)
-                        + "BrushKey";
+                    string resourceName = $"PUISignatureStatus{Enum.GetName(sigStatus)}BrushKey";


Enum.GetName(typeof(SignatureStatus), sigStatus) ?

dipeshmsft · 2024-08-27T11:57:27Z

src/Microsoft.DotNet.Wpf/src/ReachFramework/AlphaFlattener/Flattener.cs

-                        DisplayList.LeftPad(transparentCluster[i].DebugBounds, 0),
-                        DisplayList.LeftPad(transparentCluster[i].DebugPrimitives, 0),
-                        transparentCluster[i].DebugRasterize);
+                    Console.WriteLine($"Cluster {i + 1}: {DisplayList.LeftPad(transparentCluster[i].DebugBounds, 0)} {DisplayList.LeftPad(transparentCluster[i].DebugPrimitives, 0)} {transparentCluster[i].DebugRasterize}");


This interpolation is too long, can we revert this back as original ?

dipeshmsft · 2024-08-27T11:59:23Z

src/Microsoft.DotNet.Wpf/src/ReachFramework/PrintConfig/PageCanvasSize.cs

@@ -176,8 +176,7 @@ public CanvasImageableArea ImageableArea
        /// <returns>A string that represents this imageable size capability object.</returns>
        public override string ToString()
        {
-            return "ImageableSizeWidth=" + ImageableSizeWidth + ", ImageableSizeHeight=" + ImageableSizeHeight + " " +
-                   ((ImageableArea != null) ? ImageableArea.ToString() : "[ImageableArea: null]");
+            return $"ImageableSizeWidth={ImageableSizeWidth}, ImageableSizeHeight={ImageableSizeHeight} {((ImageableArea != null) ? ImageableArea.ToString() : "[ImageableArea: null]")}";


Can we split in two lines ? Too long interpolation string.

dipeshmsft · 2024-08-27T12:01:28Z

src/Microsoft.DotNet.Wpf/src/ReachFramework/PrintConfig/PTProvider.cs

-                                      PTUtility.GetTextFromResource("FormatException.XMLNotWellFormed"),
-                                      errorMsg),
-                                      "printTicket");
+                        throw new ArgumentException($"{PrintSchemaTags.Framework.PrintTicketRoot} {PTUtility.GetTextFromResource("FormatException.XMLNotWellFormed")} {errorMsg}",


I prefer the previous way here. The current change results in too long interpolation. Same suggestion for the change below and FallbackPTProvider.cs

dipeshmsft · 2024-08-27T12:04:14Z

src/Microsoft.DotNet.Wpf/src/PresentationUI/MS/Internal/Documents/Application/AddressUtility.cs

-                    _addressTemplate,
-                    mailtoUri.GetComponents(UriComponents.UserInfo, UriFormat.Unescaped),
-                    mailtoUri.GetComponents(UriComponents.Host, UriFormat.Unescaped));                                                   
+                address = $"{mailtoUri.GetComponents(UriComponents.UserInfo, UriFormat.Unescaped)}@{mailtoUri.GetComponents(UriComponents.Host, UriFormat.Unescaped)}";                                                   


Can we revert this back to the original way ? Same reasoning, too long string.

dipeshmsft · 2025-02-04T08:38:27Z

@halgab, can you take a look at the above PR and make the necessary changes ?

ghost assigned halgab Jan 28, 2024

ghost added the PR metadata: Label to tag PRs, to facilitate with triage label Jan 28, 2024

ghost requested review from dipeshmsft and singhashish-wpf January 28, 2024 20:57

ghost added the Community Contribution A label for all community Contributions label Jan 28, 2024

halgab force-pushed the interpolated-string-presui branch from d6cb976 to 999cfa6 Compare January 28, 2024 21:45

halgab marked this pull request as ready for review January 28, 2024 22:07

halgab requested a review from a team as a code owner January 28, 2024 22:07

halgab force-pushed the interpolated-string-presui branch from 999cfa6 to 22c1e96 Compare January 28, 2024 22:20

lindexi reviewed Jan 29, 2024

View reviewed changes

src/Microsoft.DotNet.Wpf/src/PresentationUI/MS/Internal/Documents/Application/DocumentStream.cs Show resolved Hide resolved

lindexi reviewed Jan 29, 2024

View reviewed changes

src/Microsoft.DotNet.Wpf/src/PresentationUI/MS/Internal/Documents/SignatureResourceHelper.cs Show resolved Hide resolved

halgab added 2 commits June 6, 2024 17:15

string.Format evictions

7a0bf08

use interpolated strings in ReachFramework and PresentationUI

717cfa0

anjali-wpf force-pushed the interpolated-string-presui branch from 22c1e96 to 717cfa0 Compare June 6, 2024 12:08

anjali-wpf added Queue for test pass and removed Queue for test pass labels Jun 6, 2024

dipeshmsft reviewed Aug 27, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Prefer use of interpolated strings in PresentationUI and ReachFramework #8739

Prefer use of interpolated strings in PresentationUI and ReachFramework #8739

halgab commented Jan 28, 2024 •

edited by ghost

Loading

dipeshmsft Aug 27, 2024

dipeshmsft Aug 27, 2024

dipeshmsft Aug 27, 2024

dipeshmsft Aug 27, 2024

dipeshmsft Aug 27, 2024

dipeshmsft Aug 27, 2024

dipeshmsft Aug 27, 2024

dipeshmsft Aug 27, 2024

dipeshmsft Aug 27, 2024

dipeshmsft Aug 27, 2024

dipeshmsft commented Feb 4, 2025

Prefer use of interpolated strings in PresentationUI and ReachFramework #8739

Are you sure you want to change the base?

Prefer use of interpolated strings in PresentationUI and ReachFramework #8739

Conversation

halgab commented Jan 28, 2024 • edited by ghost Loading

Description

Customer Impact

Regression

Testing

Risk

Microsoft Reviewers: Open in CodeFlow

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dipeshmsft commented Feb 4, 2025

halgab commented Jan 28, 2024 •

edited by ghost

Loading