String formatting in C#

String formatting in C# I couldn't find a quick reference to .NET string formatting using the String.Format() function, so I created this one. When I started working with the .NET framework, one thing puzzled me. I couldn't find sprintf(). sprintf() is the C function that takes an output buffer, a format string, and any number of arguments, and builds a string for you. For example: <blockquote dir="ltr" style="MARGIN-RIGHT: 0px"> char szError[256]; sprintf(szError, "Error %d occurred.\n", nError);</blockquote> This would write "Error 12 occurred." into the szError buffer (assuming nError was 12). It's a basic part of C programming and most C++ programmers still use it though better functionality is available in the STL because sprintf is simple to use and clear. The STL equivalent would be: <blockquote dir="ltr" style="MARGIN-RIGHT: 0px"> str << "Error " << nError << " occurred." << endl;</blockquote> Or something close to that. It's type-safe, and more OO than sprintf, but not as easy to read and not as easy to localize. The .NET framework handles strings very nicely - but it takes some getting used to. The rough equivalent of sprintf in .NET is the static String.Format function, which takes a format string and some arguments, and generates an output string. (This is a nice improvement over sprintf since there's no chance you'll overflow the output buffer). For example: <blockquote dir="ltr" style="MARGIN-RIGHT: 0px"> string errorString = String.Format("Error {0} occurred.", nError);</blockquote> Teeming with metadata, the .NET environment doesn't need the format string to say what type of data you're formatting, just where you want it. (A common sprintf bug is supplying the wrong data type - there's no protection from using %s instead of %d and having your program crash when sprintf is called). The {0} in the string above is replaced with the value of nError, but what if you want to specify the number of digits to use? Or the base (hexadecimal etc)? The framework supports all this, but where it seemed confusing is that it's not the String.Format function that does the string formatting, but rather the types themselves. Every object has a method called ToString that returns a string representation of the object. The ToString method can accept a string parameter, which tells the object how to format itself - in the String.Format call, the formatting string is passed after the position, for example, "{0:##}" The text inside the curly braces is {index[,alignment][:formatString]}. If alignment is positive, the text is right-aligned in a field the given number of spaces; if it's negative, it's left-aligned. <h3>Strings</h3> There really isn't any formatting within a strong, beyond it's alignment. Alignment works for any argument being printed in a String.Format call. <table> <tbody> <tr> <td align="middle" bgcolor="#c0c0c0">Sample</td> <td align="middle" bgcolor="#c0c0c0">Generates</td></tr> <tr> <td align="middle">String.Format("->{1,10}<-", "Hello");</td> <td>-> Hello<-</td></tr> <tr> <td align="middle"> String.Format("->{1,-10}<-", "Hello");</td> <td>->Hello <-</td></tr></tbody></table> <h3>Numbers</h3> Basic number formatting specifiers: <table> <tbody> <tr> <td align="middle" bgcolor="#c0c0c0">Specifier</td> <td align="middle" bgcolor="#c0c0c0">Type</td> <td align="middle" bgcolor="#c0c0c0">Format </td> <td align="middle" bgcolor="#c0c0c0">Output (Passed Double 1.42)</td> <td align="middle" bgcolor="#c0c0c0">Output (Passed Int -12400)</td></tr> <tr> <td align="middle">c</td> <td>Currency</td> <td>{0:c}</td> <td>$1.42</td> <td>-$12,400</td></tr> <tr> <td align="middle">d</td> <td>Decimal (Whole number)</td> <td>{0:d}</td> <td>System.FormatException</td> <td>-12400</td></tr> <tr> <td align="middle">e</td> <td>Scientific</td> <td>{0:e}</td> <td>1.420000e+000</td> <td>-1.240000e+004</td></tr> <tr> <td align="middle">f</td> <td>Fixed point</td> <td>{0:f}</td> <td>1.42</td> <td>-12400.00</td></tr> <tr> <td align="middle">g</td> <td>General</td> <td>{0:g}</td> <td>1.42</td> <td>-12400</td></tr> <tr> <td align="middle">n</td> <td>Number with commas for thousands</td> <td>{0:n}</td> <td>1.42</td> <td>-12,400</td></tr> <tr> <td align="middle">r</td> <td>Round trippable</td> <td>{0:r}</td> <td>1.42</td> <td>System.FormatException</td></tr> <tr> <td align="middle">x</td> <td>Hexadecimal</td> <td>{0:x4}</td> <td>System.FormatException</td> <td>cf90</td></tr></tbody></table> Custom number formatting: <table> <tbody> <tr> <td align="middle" bgcolor="#c0c0c0">Specifier</td> <td align="middle" bgcolor="#c0c0c0">Type</td> <td align="middle" bgcolor="#c0c0c0">Example </td> <td align="middle" bgcolor="#c0c0c0">Output (Passed Double 1500.42)</td> <td align="middle" bgcolor="#c0c0c0">Note</td></tr> <tr> <td align="middle">0</td> <td>Zero placeholder</td> <td align="middle">{0:00.0000}</td> <td>1500.4200</td> <td>Pads with zeroes.</td></tr> <tr> <td align="middle">#</td> <td>Digit placeholder</td> <td align="middle">{0:(#).##}</td> <td>(1500).42</td> <td> </td></tr> <tr> <td align="middle">.</td> <td>Decimal point</td> <td align="middle">{0:0.0}</td> <td>1500.4</td> <td> </td></tr> <tr> <td align="middle">,</td> <td>Thousand separator</td> <td align="middle">{0:0,0}</td> <td>1,500</td> <td>Must be between two zeroes.</td></tr> <tr> <td align="middle">,.</td> <td>Number scaling</td> <td align="middle">{0:0,.} </td> <td>2</td> <td>Comma adjacent to Period scales by 1000.</td></tr> <tr> <td align="middle">%</td> <td>Percent</td> <td align="middle">{0:0%}</td> <td>150042%</td> <td>Multiplies by 100, adds % sign.</td></tr> <tr> <td align="middle">e</td> <td>Exponent placeholder</td> <td align="middle">{0:00e+0}</td> <td>15e+2</td> <td>Many exponent formats available.</td></tr> <tr> <td align="middle">;</td> <td>Group separator</td> <td align="middle">see below</td> <td> </td> <td> </td></tr></tbody></table> The group separator is especially useful for formatting currency values which require that negative values be enclosed in parentheses. This currency formatting example at the bottom of this document makes it obvious: <h3>Dates</h3> Note that date formatting is especially dependant on the system's regional settings; the example strings here are from my local locale. <table> <tbody> <tr> <td align="middle" bgcolor="#c0c0c0">Specifier</td> <td align="middle" bgcolor="#c0c0c0">Type</td> <td align="middle" bgcolor="#c0c0c0">Example (Passed System.DateTime.Now)</td></tr> <tr> <td align="middle">d</td> <td>Short date</td> <td>10/12/2002</td></tr> <tr> <td align="middle">D</td> <td>Long date</td> <td>December 10, 2002</td></tr> <tr> <td align="middle">t</td> <td>Short time</td> <td>10:11 PM</td></tr> <tr> <td align="middle">T</td> <td>Long time</td> <td>10:11:29 PM</td></tr> <tr> <td align="middle">f</td> <td>Full date & time </td> <td>December 10, 2002 10:11 PM</td></tr> <tr> <td align="middle">F</td> <td>Full date & time (long)</td> <td>December 10, 2002 10:11:29 PM</td></tr> <tr> <td align="middle">g</td> <td>Default date & time</td> <td>10/12/2002 10:11 PM</td></tr> <tr> <td align="middle">G</td> <td>Default date & time (long)</td> <td>10/12/2002 10:11:29 PM</td></tr> <tr> <td align="middle">M</td> <td>Month day pattern</td> <td>December 10</td></tr> <tr> <td align="middle">r</td> <td>RFC1123 date string</td> <td>Tue, 10 Dec 2002 22:11:29 GMT</td></tr> <tr> <td align="middle">s</td> <td>Sortable date string</td> <td>2002-12-10T22:11:29</td></tr> <tr> <td align="middle">u</td> <td>Universal sortable, local time</td> <td>2002-12-10 22:13:50Z</td></tr> <tr> <td align="middle">U</td> <td>Universal sortable, GMT</td> <td>December 11, 2002 3:13:50 AM</td></tr> <tr> <td align="middle">Y</td> <td>Year month pattern</td> <td>December, 2002</td></tr></tbody></table> The 'U' specifier seems broken; that string certainly isn't sortable. Custom date formatting: <table> <tbody> <tr> <td align="middle" bgcolor="#c0c0c0">Specifier</td> <td align="middle" bgcolor="#c0c0c0">Type</td> <td align="middle" bgcolor="#c0c0c0">Example </td> <td align="middle" bgcolor="#c0c0c0">Example Output</td></tr> <tr> <td align="middle">dd</td> <td>Day</td> <td align="middle">{0:dd}</td> <td>10</td></tr> <tr> <td align="middle">ddd</td> <td>Day name</td> <td align="middle">{0:ddd}</td> <td>Tue</td></tr> <tr> <td align="middle">dddd</td> <td>Full day name</td> <td align="middle">{0:dddd}</td> <td>Tuesday</td></tr> <tr> <td align="middle">f, ff, ...</td> <td>Second fractions</td> <td align="middle">{0:fff}</td> <td>932</td></tr> <tr> <td align="middle">gg, ...</td> <td>Era</td> <td align="middle">{0:gg}</td> <td>A.D.</td></tr> <tr> <td align="middle">hh</td> <td>2 digit hour</td> <td align="middle">{0:hh}</td> <td>10</td></tr> <tr> <td align="middle">HH</td> <td>2 digit hour, 24hr format</td> <td align="middle">{0:HH}</td> <td>22</td></tr> <tr> <td align="middle">mm</td> <td>Minute 00-59</td> <td align="middle">{0:mm}</td> <td>38</td></tr> <tr> <td align="middle">MM</td> <td>Month 01-12</td> <td align="middle">{0:MM}</td> <td>12</td></tr> <tr> <td align="middle">MMM</td> <td>Month abbreviation</td> <td align="middle">{0:MMM}</td> <td>Dec</td></tr> <tr> <td align="middle">MMMM</td> <td>Full month name</td> <td align="middle">{0:MMMM}</td> <td>December</td></tr> <tr> <td align="middle">ss</td> <td>Seconds 00-59</td> <td align="middle">{0:ss}</td> <td>46</td></tr> <tr> <td align="middle">tt</td> <td>AM or PM</td> <td align="middle">{0:tt}</td> <td>PM</td></tr> <tr> <td align="middle">yy</td> <td>Year, 2 digits</td> <td align="middle">{0:yy}</td> <td>02</td></tr> <tr> <td align="middle">yyyy</td> <td>Year</td> <td align="middle">{0:yyyy}</td> <td>2002</td></tr> <tr> <td align="middle">zz</td> <td>Timezone offset, 2 digits</td> <td align="middle">{0:zz}</td> <td>-05</td></tr> <tr> <td align="middle">zzz</td> <td>Full timezone offset</td> <td align="middle">{0:zzz}</td> <td>-05:00</td></tr> <tr> <td align="middle">:</td> <td>Separator</td> <td align="middle">{0:hh:mm:ss}</td> <td>10:43:20</td></tr> <tr> <td align="middle">/</td> <td>Separator</td> <td align="middle">{0:dd/MM/yyyy}</td> <td>10/12/2002</td></tr></tbody></table> <h3>Enumerations</h3> <table> <tbody> <tr> <td align="middle" bgcolor="#c0c0c0">Specifier</td> <td align="middle" bgcolor="#c0c0c0">Type</td></tr> <tr> <td align="middle">g</td> <td>Default (Flag names if available, otherwise decimal)</td></tr> <tr> <td align="middle">f</td> <td>Flags always</td></tr> <tr> <td align="middle">d</td> <td>Integer always</td></tr> <tr> <td align="middle">x</td> <td>Eight digit hex.</td></tr></tbody></table> <h3>Some Useful Examples</h3> String.Format("{0:$#,##0.00;($#,##0.00);Zero}", value); <blockquote dir="ltr" style="MARGIN-RIGHT: 0px"> This will output "$1,240.00" if passed 1243.50. It will output the same format but in parentheses if the number is negative, and will output the string "Zero" if the number is zero.</blockquote> String.Format("{0:(###) ###-####}", 18005551212); <blockquote dir="ltr" style="MARGIN-RIGHT: 0px"> This will output "(800) 555-1212".</blockquote> If you have any questions about string formatting, or pretty much anything related, drop by the <a href=http://www.stevex.org/forums/Default.aspx?g=topics&f=31>Forum</a> and ask it there. It's an easier place to talk than in the comments section here. Thu, 01 Sep 2005 19:17:04 GMT