Click here to Skip to main content
Click here to Skip to main content
Technical Blog

TIP: Improve Readability with Shorter String.Format Statements

, 3 Jul 2010 CPOL
Rate this:
Please Sign up or sign in to vote.
String.Format is a wonderful method, a real life saver when it comes to producing (readable) formatted text from within code. 

String.Format is a wonderful method, a real life saver when it comes to producing (readable) formatted text from within code. I use it everywhere, but it gets a bit tedious typing the same boilerplate code to use it properly:

string formatted = string.Format(CultureInfo.InvariantCulture, 
"Formatted text {0:-15} example generated on {1:d}", meaningfulString, DateTime.Now);

That “string.Format(CultureInfo.InvariantCulture,” over 40 characters before you get the meat of the statement.  Sure you can drop the invariant culture bit but then you can introduce weird formatting problems on different machines…. no, what I need is a useful extension method to take my pain away:

 /// <span class="code-SummaryComment"><summary>
</span> /// Populates the template using the provided arguments and the invariant culture
 /// <span class="code-SummaryComment"></summary>
</span> /// <span class="code-SummaryComment"><param name="template">The template.
</span> /// <span class="code-SummaryComment"><param name="args">The args.
</span> public static string ToFormattedString(this string template, params object[] args)
 {
     return template.ToFormattedString(CultureInfo.InvariantCulture, args);
 }
  
 /// <span class="code-SummaryComment"><summary>
</span> /// Populates the template using the provided arguments using the provided formatter
 /// <span class="code-SummaryComment"></summary>
</span> /// <span class="code-SummaryComment"><param name="template">The template.
</span> /// <span class="code-SummaryComment"><param name="formatter">The formatter.
</span> /// <span class="code-SummaryComment"><param name="args">The args.
</span> public static string ToFormattedString(this string template, 
	IFormatProvider formatter, params object[] args)
 {
     if (string.IsNullOrEmpty(template)) return string.Empty;
     return string.Format(formatter, template, args);
 }

Now the above example becomes:

 string formatted = "Formatted text {0:-15} 
	example generated on {1:d}".ToFormattedString(meaningfulString, DateTime.Now);

It’s definitely an improvement and the important bit of the statement (the template with formatting) is right at the front for easy debugging.

Excellent, How Do I Retrofit This Into My Existing Code?

Good question, glad you asked.  I simply used Visual Studio's Find and Replace using regular expressions:

image

The find regex (using VS’s “special” regex format) is:

string.Format\(CultureInfo.InvariantCulture,:b*{:q|:i}:b@,:b@

The replace regex is:

\1.ToFormattedString(

Obviously, you'll also need a ‘using’ statement at the top of your class file with the namespace of the static class containing the extension methods.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

Martin Jarvis
Software Developer (Senior) Freestyle Interactive Ltd
United Kingdom United Kingdom
I'm a lead developer for Freestyle Interactive Ltd where we create many wonderful websites built on Microsofts ASP.Net and Ektron CMS.
 
I've been developing .Net applications (both Windows and Web) since 2002.
Follow on   Twitter

Comments and Discussions

 
GeneralMy vote of 1 PinmemberEugene Sichkar15-Jul-10 23:56 
GeneralRe: My vote of 1 PinmemberMartin Jarvis3-Aug-10 11:17 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web04 | 2.8.141029.1 | Last Updated 3 Jul 2010
Article Copyright 2010 by Martin Jarvis
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid