.NET Framework 开发人员指南 --复合格式化

原文：http://blog.sina.com.cn/u/4a8920f9010007dv

通过 .NET Framework 复合格式化功能，您可以提供值列表和由交替出现的固定文本和索引占位符组成的源字符串，还能轻松地获得由夹杂着格式化值的原始固定文本组成的结果字符串。复合格式化可以用于一些方法，如 String.Format（返回格式化字符串）方法和 Console.WriteLine（将输出字符串显示到控制台）方法等，也可用于 TextWriter.WriteLine（将输出字符串写到流或文件）的实现。

每个索引占位符或格式项都对应值列表中的一个元素。复合格式化功能返回新的输出字符串，其中嵌入源字符串的每个格式项都被对应的格式化值替换。

源字符串包含被一个或多个格式项分隔开的零个或多个固定文本段。固定文本可以包含您选择的任何内容。

下面是一个 String.Format 示例。

Visual Basic  复制代码
Dim myName As String = "Fred"
String.Format("Name = {0}, hours = {1:hh}", myName, DateTime.Now)
 
C#  复制代码
string myName = "Fred";
String.Format("Name = {0}, hours = {1:hh}", myName, DateTime.Now);
 

固定文本为“Name = ”和“, hours = ”。格式项为“{0}”和“{1:hh}”。值列表为 myName 和 DateTime.Now。

格式项语法
所有格式项都采用下面的形式。

{index[,alignment][:formatString]}

必须使用成对的大括号（“{”和“}”）。

格式项组件
格式项由下面的组件构成。

索引组件
强制“索引”组件（也叫参数说明符）是一个从 0 开始的数字，可标识值列表中对应的元素。也就是说，参数说明符为 0 的格式项格式化列表中的第一个值，参数说明符为 1 的格式项格式化列表中的第二个值，依次类推。

通过指定相同的参数说明符，多个格式项可以引用值列表中的同一个元素。例如，通过指定类似于“{0:X} {0:E} {0:N}”的源字符串，可以将同一个数值格式化为十六进制、科学表示法和数字格式。

每一个格式项都可以引用所有的参数。例如，如果有三个值，则可以通过指定类似于“{1} {0} {2}”的源字符串来格式化第二、第一和第三个值。格式项未引用的值会被忽略。如果参数说明符指定了超出值列表范围的项，将导致运行时异常。

对齐组件
可选的“对齐”组件是一个带符号的整数，指示首选的格式化字段宽度。如果“对齐”值小于格式化字符串的长度，“对齐”会被忽略，并且使用格式化字符串的长度作为字段宽度。如果“对齐”为正数，字段的格式化数据为右对齐；如果“对齐”为负数，字段的格式化数据为左对齐。如果需要填充，则使用空白。如果指定“对齐”，就需要使用逗号。

格式字符串组件
可选的“格式字符串”组件由标准或自定义格式说明符组成。如果不指定“格式字符串”，则使用常规（“G”）格式说明符。如果指定“格式说明符”，需要使用冒号。

转义大括号
左大括号和右大括号被解释为格式项的开始和结束。因此，必须使用转义序列显示文本左大括号或右大括号。在固定文本中指定两个左大括号 ("{{") 以显示一个左大括号 ("{")，或指定两个右大括号 ("}}") 以显示一个右大括号 ("}")。按照在格式项中遇到大括号的顺序依次解释它们。不支持解释嵌套的大括号。

解释转义大括号的方式会导致意外的结果。例如，考虑要显示一个左大括号、一个格式化为十进制数的数值和一个右大括号的格式项“{{{0:D}}}”。但是，实际是按照以下方式解释该格式项：

前两个左大括号 ("{{") 被转义，生成一个左大括号。

之后的三个字符 ("{0:") 被解释为格式项的开始。

下一个字符 ("D") 将被解释为 Decimal 标准数值格式说明符，但后面的两个转义大括号 ("}}") 生成单个大括号。由于得到的字符串 ("D}") 不是标准数值格式说明符号，所以得到的字符串会被解释为用于显示字符串“D}”的自定义格式字符串。

最后一个大括号 ("}") 被解释为格式项的结束。

显示的最终结果是字符串“{D}”。不会显示本来要格式化的数值。

在编写代码时，避免错误解释转义大括号和格式项的一种方法是单独显示大括号和格式项。也就是说，显示左大括号，再显示格式项的结果，然后显示右大括号。

处理顺序
如果要格式化的值是 null（在 Visual Basic 中为 Nothing），则返回空字符串 ("")。

如果要格式化的类型实现 ICustomFormatter 接口，则调用 ICustomFormatter.Format 方法。

如果前面的步骤未格式化类型，并且该类型实现 IFormattable 接口，则调用 IFormattable.ToString 方法。

如果前面的步骤未格式化类型，则调用该类型的 ToString 方法（从 Object 类继承而来）。

前面的步骤执行完毕之后应用对齐。

代码示例
下面的示例显示使用复合格式化创建的一个字符串和使用对象的 ToString 方法创建的另一个字符串。两种格式化类型产生相同的结果。

Visual Basic  复制代码
Dim FormatString1 As String = String.Format("{0:dddd MMMM}", DateTime.Now)
Dim FormatString2 As String = DateTime.Now.ToString("dddd MMMM")

C#  复制代码
string FormatString1 = String.Format("{0:dddd MMMM}", DateTime.Now);
string FormatString2 = DateTime.Now.ToString("dddd MMMM");
 

假定当前日期是五月的星期四，在美国英语区域性中上述示例中的两个字符串的值都是 Thursday May。

Console.WriteLine 与 String.Format 公开相同功能。两种方法的唯一差异是 String.Format 将其结果作为字符串返回，而 Console.WriteLine 将结果写入与 Console 对象关联的输出流。下面的示例使用 Console.WriteLine 方法将 MyInt 的值格式化为货币值。

Visual Basic  复制代码
Dim MyInt As Integer = 100
Console.WriteLine("{0:C}", MyInt)

C#  复制代码
int MyInt = 100;
Console.WriteLine("{0:C}", MyInt);
 

此代码在当前区域性为美国英语的计算机上，将 $100.00 显示到控制台。

下面的示例说明格式化多个对象，包括用两种不同的方式格式化一个对象。

Visual Basic  复制代码
Dim myName As String = "Fred"
String.Format("Name = {0}, hours = {1:hh}, minutes = {1:mm}",
      myName, DateTime.Now)

C#  复制代码
string myName = "Fred";
String.Format("Name = {0}, hours = {1:hh}, minutes = {1:mm}",
      myName, DateTime.Now);
 

以上字符串的输出是“Name = Fred, hours = 07, minutes = 23”，其中当前的时间反映了这些数字。

下列示例说明了对齐在格式化中的使用。格式化的参数放置在竖线字符 (|) 之间以突出显示得到的对齐。

Visual Basic  复制代码
Dim myFName As String = "Fred"
Dim myLName As String = "Opals"
Dim myInt As Integer = 100
Dim FormatFName As String = String.Format("First Name = |{0,10}|", myFName)
Dim FormatLName As String = String.Format("Last Name = |{0,10}|", myLName)
Dim FormatPrice As String = String.Format("Price = |{0,10:C }|", myInt)
Console.WriteLine(FormatFName)
Console.WriteLine(FormatLName)
Console.WriteLine(FormatPrice)

FormatFName = String.Format("First Name = |{0,-10}|", myFName)
FormatLName = String.Format("Last Name = |{0,-10}|", myLName)
FormatPrice = String.Format("Price = |{0,-10:C }|", myInt)
Console.WriteLine(FormatFName)
Console.WriteLine(FormatLName)
Console.WriteLine(FormatPrice)

C#  复制代码
string myFName = "Fred";
string myLName = "Opals";
int myInt = 100;
string FormatFName = String.Format("First Name = |{0,10}|", myFName);
string FormatLName = String.Format("Last Name = |{0,10}|", myLName);
string FormatPrice = String.Format("Price = |{0,10:C}|", myInt);
Console.WriteLine(FormatFName);
Console.WriteLine(FormatLName);
Console.WriteLine(FormatPrice);

FormatFName = String.Format("First Name = |{0,-10}|", myFName);
FormatLName = String.Format("Last Name = |{0,-10}|", myLName);
FormatPrice = String.Format("Price = |{0,-10:C}|", myInt);
Console.WriteLine(FormatFName);
Console.WriteLine(FormatLName);
Console.WriteLine(FormatPrice);
 

在美国英语区域性中，上述代码将下列内容显示到控制台。不同的区域性显示不同的货币符号和分隔符。

  复制代码
First Name = |          Fred|
Last Name = |         Opals|
Price = |           $100.00|
First Name = |Fred      |
Last Name = |Opals     |
Price = |$100.00   |
 

 

原文：http://blog.sina.com.cn/u/4a8920f9010007dv