String.Format 方法

定义

命名空间:

System

程序集:

System.Runtime.dll

根据指定的格式将对象值转换为字符串，并将其插入另一个字符串中。

如果不熟悉 String.Format 方法，请参阅 String.Format 方法入门，获取快速概述。

重载

Format(IFormatProvider, String, Object[])	将字符串中的格式项替换为指定数组中相应对象的字符串表示形式。 参数提供区域性特定的格式设置信息。
Format(IFormatProvider, String, Object, Object, Object)	将字符串中的格式项替换为三个指定对象的字符串表示形式。 参数提供区域性特定的格式设置信息。
Format(String, Object, Object, Object)	将字符串中的格式项替换为三个指定对象的字符串表示形式。
Format(IFormatProvider, String, Object, Object)	将字符串中的格式项替换为两个指定对象的字符串表示形式。 参数提供区域性特定的格式设置信息。
Format(String, Object, Object)	将字符串中的格式项替换为两个指定对象的字符串表示形式。
Format(IFormatProvider, CompositeFormat, ReadOnlySpan<Object>)	将 CompositeFormat 中的格式项或项替换为指定格式中相应对象的字符串表示形式。
Format(IFormatProvider, String, Object)	将指定字符串中的格式项或项替换为相应对象的字符串表示形式。 参数提供区域性特定的格式设置信息。
Format(String, Object[])	将指定字符串中的格式项替换为指定数组中相应对象的字符串表示形式。
Format(String, Object)	将字符串中的一个或多个格式项替换为指定对象的字符串表示形式。
Format(IFormatProvider, CompositeFormat, Object[])	将 CompositeFormat 中的格式项或项替换为指定格式中相应对象的字符串表示形式。
Format<TArg0,TArg1,TArg2>(IFormatProvider, CompositeFormat, TArg0, TArg1, TArg2)	将 CompositeFormat 中的格式项或项替换为指定格式中相应对象的字符串表示形式。
Format<TArg0,TArg1>(IFormatProvider, CompositeFormat, TArg0, TArg1)	将 CompositeFormat 中的格式项或项替换为指定格式中相应对象的字符串表示形式。
Format<TArg0>(IFormatProvider, CompositeFormat, TArg0)	将 CompositeFormat 中的格式项或项替换为指定格式中相应对象的字符串表示形式。

注解

有关此 API 的详细信息，请参阅 String.Format的 补充 API 说明。

Format(IFormatProvider, String, Object[])

Source:

String.Manipulation.cs

将字符串中的格式项替换为指定数组中相应对象的字符串表示形式。 参数提供区域性特定的格式设置信息。

C#

public static string Format (IFormatProvider? provider, string format, params object?[] args);

参数

provider

IFormatProvider

提供区域性特定的格式设置信息的对象。

format

String

复合格式字符串。

args

Object[]

包含要设置格式的零个或多个对象的对象数组。

返回

String

format 的副本，其中格式项已替换为 args中相应对象的字符串表示形式。

例外

ArgumentNullException

format 或 argsnull。

FormatException

format 无效。

-或-

格式项的索引小于零，或大于或等于 args 数组的长度。

注解

重要

如果语言支持字符串，则可以使用 内插字符串，而不是调用 String.Format 方法或使用 复合格式字符串。 内插字符串是一个字符串，其中包含 内插表达式。 每个内插表达式都使用表达式的值解析，并在分配字符串时包含在结果字符串中。 有关详细信息，请参阅 字符串内插（C# 参考） 和 内插字符串（Visual Basic 参考）。

此方法使用 复合格式设置功能 将四个或多个表达式转换为其字符串表示形式，并在字符串中嵌入这些表示形式。 在执行转换时，该方法使用区分区域性的格式或自定义格式化程序。 该方法通过调用其 ToString（IFormatProvider） 方法将每个 Object 参数转换为其字符串表示形式;或者，如果对象的相应格式项包含格式字符串，则调用其 ToString（String，IFormatProvider） 方法。 如果这些方法不存在，它将调用对象的无参数 ToString 方法。

但是，在调用 String.Format 方法时，不必专注于要调用的特定重载。 相反，可以使用提供区域性敏感或自定义格式的对象和包含一个或多个格式项的 复合格式字符串 调用该方法。 为每个格式项分配一个数字索引;第一个索引从 0 开始。 除了初始字符串，方法调用应具有与索引值一样多的其他参数。 例如，格式项的索引为 0 和 1 的字符串应具有 2 个参数;索引为 0 到 5 的 1 个参数应具有 6 个参数。 然后，语言编译器会将方法调用解析为 String.Format 方法的特定重载。

有关使用 String.Format 方法的更详细文档，请参阅 String.Format 方法入门 和 我调用哪种方法？。

示例：区分区域性的格式

此示例使用 Format(IFormatProvider, String, Object[]) 方法通过多种不同区域性显示某些日期和时间值的字符串表示形式和数值。

C#

string[] cultureNames = { "en-US", "fr-FR", "de-DE", "es-ES" };

DateTime dateToDisplay = new DateTime(2009, 9, 1, 18, 32, 0);
double value = 9164.32;

Console.WriteLine("Culture     Date                                Value\n");
foreach (string cultureName in cultureNames)
{
   System.Globalization.CultureInfo culture = new System.Globalization.CultureInfo(cultureName);
   string output = String.Format(culture, "{0,-11} {1,-35:D} {2:N}", 
                                 culture.Name, dateToDisplay, value);
   Console.WriteLine(output);
}    
// The example displays the following output:
//    Culture     Date                                Value
//    
//    en-US       Tuesday, September 01, 2009         9,164.32
//    fr-FR       mardi 1 septembre 2009              9 164,32
//    de-DE       Dienstag, 1. September 2009         9.164,32
//    es-ES       martes, 01 de septiembre de 2009    9.164,32

另请参阅

• DateTimeFormatInfo
• ICustomFormatter
• IFormatProvider
• NumberFormatInfo
• .NET 中的格式设置类型
• 复合格式设置
• 标准日期和时间格式字符串
• 自定义日期和时间格式字符串
• 标准数字格式字符串
• 自定义数字格式字符串
• 标准 TimeSpan 格式字符串
• 自定义 TimeSpan 格式字符串
• 枚举格式字符串

Format(IFormatProvider, String, Object, Object, Object)

Source:

String.Manipulation.cs

将字符串中的格式项替换为三个指定对象的字符串表示形式。 参数提供区域性特定的格式设置信息。

C#

public static string Format (IFormatProvider? provider, string format, object? arg0, object? arg1, object? arg2);

参数

provider

IFormatProvider

提供区域性特定的格式设置信息的对象。

format

String

复合格式字符串。

arg0

Object

要设置格式的第一个对象。

arg1

Object

要设置格式的第二个对象。

arg2

Object

要设置格式的第三个对象。

返回

String

format 的副本，其中格式项已替换为 arg0、arg1和 arg2的字符串表示形式。

例外

ArgumentNullException

format null。

FormatException

format 无效。

-或-

格式项的索引小于零，或大于 2。

注解

重要

如果语言支持字符串，则可以使用 内插字符串，而不是调用 String.Format 方法或使用 复合格式字符串。 内插字符串是一个字符串，其中包含 内插表达式。 每个内插表达式都使用表达式的值解析，并在分配字符串时包含在结果字符串中。 有关详细信息，请参阅 字符串内插（C# 参考） 和 内插字符串（Visual Basic 参考）。

此方法使用 复合格式设置功能 将三个表达式转换为其字符串表示形式，并在字符串中嵌入这些表示形式。 在执行转换时，该方法使用区分区域性的格式或自定义格式化程序。 该方法通过调用其 ToString（IFormatProvider） 方法将每个 Object 参数转换为其字符串表示形式;或者，如果对象的相应格式项包含格式字符串，则调用其 ToString（String，IFormatProvider） 方法。 如果这些方法不存在，它将调用对象的无参数 ToString 方法。

但是，在调用 String.Format 方法时，不必专注于要调用的特定重载。 相反，可以使用提供区域性敏感或自定义格式的对象和包含一个或多个格式项的 复合格式字符串 调用该方法。 为每个格式项分配一个数字索引;第一个索引从 0 开始。 除了初始字符串，方法调用应具有与索引值一样多的其他参数。 例如，格式项的索引为 0 和 1 的字符串应具有 2 个参数;索引为 0 到 5 的 1 个参数应具有 6 个参数。 然后，语言编译器会将方法调用解析为 String.Format 方法的特定重载。

有关使用 String.Format 方法的更详细文档，请参阅 String.Format 方法入门 和 我调用哪种方法？。

Format(String, Object, Object, Object)

Source:

String.Manipulation.cs

将字符串中的格式项替换为三个指定对象的字符串表示形式。

C#

public static string Format (string format, object? arg0, object? arg1, object? arg2);

参数

format

String

复合格式字符串。

arg0

Object

要设置格式的第一个对象。

arg1

Object

要设置格式的第二个对象。

arg2

Object

要设置格式的第三个对象。

返回

String

format 的副本，其中格式项已替换为 arg0、arg1和 arg2的字符串表示形式。

例外

ArgumentNullException

format null。

FormatException

format 无效。

-或-

格式项的索引小于零，或大于 2。

注解

重要

如果语言支持字符串，则可以使用 内插字符串，而不是调用 String.Format 方法或使用 复合格式字符串。 内插字符串是一个字符串，其中包含 内插表达式。 每个内插表达式都使用表达式的值解析，并在分配字符串时包含在结果字符串中。 有关详细信息，请参阅 字符串内插（C# 参考） 和 内插字符串（Visual Basic 参考）。

此方法使用 复合格式设置功能 将三个表达式的值转换为其字符串表示形式，并在字符串中嵌入这些表示形式。

但是，在调用 String.Format 方法时，不必专注于要调用的特定重载。 相反，可以使用包含一个或多个格式项的 复合格式字符串 调用该方法。 为每个格式项分配一个数字索引;第一个索引从 0 开始。 除了初始字符串，方法调用应具有与索引值一样多的其他参数。 例如，格式项的索引为 0 和 1 的字符串应具有 2 个参数;索引为 0 到 5 的 1 个参数应具有 6 个参数。 然后，语言编译器会将方法调用解析为 String.Format 方法的特定重载。

有关使用 String.Format 方法的更详细文档，请参阅 String.Format 方法入门 和 我调用哪种方法？。

示例：设置三个参数的格式

此示例使用 Format(String, Object, Object, Object) 方法创建一个字符串，该字符串演示具有两个整数值的布尔 And 运算的结果。 请注意，格式字符串包含六个格式项，但该方法在其参数列表中只有三个项，因为每个项采用两种不同的格式设置。

C#

string formatString = "    {0,10} ({0,8:X8})\n" + 
                      "And {1,10} ({1,8:X8})\n" + 
                      "  = {2,10} ({2,8:X8})";
int value1 = 16932;
int value2 = 15421;
string result = String.Format(formatString, 
                              value1, value2, value1 & value2);
Console.WriteLine(result);
// The example displays the following output:
//                16932 (00004224)
//       And      15421 (00003C3D)
//         =         36 (00000024)

另请参阅

• .NET 中的格式设置类型
• 复合格式设置

Format(IFormatProvider, String, Object, Object)

Source:

String.Manipulation.cs

将字符串中的格式项替换为两个指定对象的字符串表示形式。 参数提供区域性特定的格式设置信息。

C#

public static string Format (IFormatProvider? provider, string format, object? arg0, object? arg1);

参数

provider

IFormatProvider

提供区域性特定的格式设置信息的对象。

format

String

复合格式字符串。

arg0

Object

要设置格式的第一个对象。

arg1

Object

要设置格式的第二个对象。

返回

String

format 的副本，格式项将替换为 arg0 和 arg1的字符串表示形式。

例外

ArgumentNullException

format null。

FormatException

format 无效。

-或-

格式项的索引不为零或 1。

注解

重要

如果语言支持字符串，则可以使用 内插字符串，而不是调用 String.Format 方法或使用 复合格式字符串。 内插字符串是一个字符串，其中包含 内插表达式。 每个内插表达式都使用表达式的值解析，并在分配字符串时包含在结果字符串中。 有关详细信息，请参阅 字符串内插（C# 参考） 和 内插字符串（Visual Basic 参考）。

此方法使用 复合格式设置功能 将两个表达式转换为其字符串表示形式，并在字符串中嵌入这些表示形式。 在执行转换时，该方法使用区分区域性的格式或自定义格式化程序。 该方法通过调用其 ToString（IFormatProvider） 方法将每个 Object 参数转换为其字符串表示形式;或者，如果对象的相应格式项包含格式字符串，则调用其 ToString（String，IFormatProvider） 方法。 如果这些方法不存在，它将调用对象的无参数 ToString 方法。

但是，在调用 String.Format 方法时，不必专注于要调用的特定重载。 相反，可以使用提供区域性敏感或自定义格式的对象和包含一个或多个格式项的 复合格式字符串 调用该方法。 为每个格式项分配一个数字索引;第一个索引从 0 开始。 除了初始字符串，方法调用应具有与索引值一样多的其他参数。 例如，格式项的索引为 0 和 1 的字符串应具有 2 个参数;索引为 0 到 5 的 1 个参数应具有 6 个参数。 然后，语言编译器会将方法调用解析为 String.Format 方法的特定重载。

有关使用 String.Format 方法的更详细文档，请参阅 String.Format 方法入门 和 我调用哪种方法？。

Format(String, Object, Object)

Source:

String.Manipulation.cs

将字符串中的格式项替换为两个指定对象的字符串表示形式。

C#

public static string Format (string format, object? arg0, object? arg1);

参数

format

String

复合格式字符串。

arg0

Object

要设置格式的第一个对象。

arg1

Object

要设置格式的第二个对象。

返回

String

format 的副本，格式项将替换为 arg0 和 arg1的字符串表示形式。

例外

ArgumentNullException

format null。

FormatException

format 无效。

-或-

格式项的索引不为零或 1。

注解

重要

如果语言支持字符串，则可以使用 内插字符串，而不是调用 String.Format 方法或使用 复合格式字符串。 内插字符串是一个字符串，其中包含 内插表达式。 每个内插表达式都使用表达式的值解析，并在分配字符串时包含在结果字符串中。 有关详细信息，请参阅 字符串内插（C# 参考） 和 内插字符串（Visual Basic 参考）。

此方法使用 复合格式设置功能 将两个表达式的值转换为其字符串表示形式，并在字符串中嵌入这些表示形式。

但是，在调用 String.Format 方法时，不必专注于要调用的特定重载。 相反，可以使用包含一个或多个格式项的 复合格式字符串 调用该方法。 为每个格式项分配一个数字索引;第一个索引从 0 开始。 除了初始字符串，方法调用应具有与索引值一样多的其他参数。 例如，格式项的索引为 0 和 1 的字符串应具有 2 个参数;索引为 0 到 5 的 1 个参数应具有 6 个参数。 然后，语言编译器会将方法调用解析为 String.Format 方法的特定重载。

有关使用 String.Format 方法的更详细文档，请参阅 String.Format 方法入门 和 我调用哪种方法？。

示例：设置两个参数的格式

此示例使用 Format(String, Object, Object) 方法显示存储在泛型 Dictionary<TKey,TValue> 对象中的时间和温度数据。 请注意，格式字符串有三个格式项，尽管只有两个对象可以设置格式。 这是因为列表中的第一个对象（日期和时间值）由两个格式项使用：第一个格式项显示时间，第二个显示日期。

C#

Dictionary<DateTime, Double> temperatureInfo = new Dictionary<DateTime, Double>(); 
temperatureInfo.Add(new DateTime(2010, 6, 1, 14, 0, 0), 87.46);
temperatureInfo.Add(new DateTime(2010, 12, 1, 10, 0, 0), 36.81);

Console.WriteLine("Temperature Information:\n");
string output;   
foreach (var item in temperatureInfo)
{
   output = String.Format("Temperature at {0,8:t} on {0,9:d}: {1,5:N1}°F", 
                          item.Key, item.Value);
   Console.WriteLine(output);
}
// The example displays output like the following:
//       Temperature Information:
//       
//       Temperature at  2:00 PM on  6/1/2010:  87.5°F
//       Temperature at 10:00 AM on 12/1/2010:  36.8°F

另请参阅

• .NET 中的格式设置类型
• 复合格式设置
• 标准日期和时间格式字符串
• 自定义日期和时间格式字符串
• 标准数字格式字符串
• 自定义数字格式字符串
• 标准 TimeSpan 格式字符串
• 自定义 TimeSpan 格式字符串
• 枚举格式字符串

Format(IFormatProvider, CompositeFormat, ReadOnlySpan<Object>)

Source:

String.Manipulation.cs

将 CompositeFormat 中的格式项或项替换为指定格式中相应对象的字符串表示形式。

C#

public static string Format (IFormatProvider? provider, System.Text.CompositeFormat format, ReadOnlySpan<object?> args);

参数

provider

IFormatProvider

提供区域性特定的格式设置信息的对象。

format

CompositeFormat

CompositeFormat。

args

ReadOnlySpan<Object>

要设置格式的对象范围。

返回

String

带格式的字符串。

例外

ArgumentNullException

format null。

FormatException

格式项的索引大于或等于提供的参数数。

Format(IFormatProvider, String, Object)

Source:

String.Manipulation.cs

将指定字符串中的格式项或项替换为相应对象的字符串表示形式。 参数提供区域性特定的格式设置信息。

C#

public static string Format (IFormatProvider? provider, string format, object? arg0);

参数

provider

IFormatProvider

提供区域性特定的格式设置信息的对象。

format

String

复合格式字符串。

arg0

Object

要设置格式的对象。

返回

String

format 的副本，其中格式项或项已替换为 arg0的字符串表示形式。

例外

ArgumentNullException

format null。

FormatException

format 无效。

-或-

格式项的索引不为零。

注解

重要

如果语言支持字符串，则可以使用 内插字符串，而不是调用 String.Format 方法或使用 复合格式字符串。 内插字符串是一个字符串，其中包含 内插表达式。 每个内插表达式都使用表达式的值解析，并在分配字符串时包含在结果字符串中。 有关详细信息，请参阅 字符串内插（C# 参考） 和 内插字符串（Visual Basic 参考）。

此方法使用 复合格式设置功能 将表达式的值转换为其字符串表示形式，并将该表示形式嵌入字符串中。 在执行转换时，该方法使用区分区域性的格式或自定义格式化程序。 该方法通过调用 ToString（IFormatProvider） 方法，或者，如果对象的相应格式项包含格式字符串，则通过调用其 ToString（String，IFormatProvider） 方法，将 arg0 转换为其字符串表示形式。 如果这些方法不存在，它将调用对象的无参数 ToString 方法。

但是，在调用 String.Format 方法时，不必专注于要调用的特定重载。 相反，可以使用提供区域性敏感或自定义格式的对象和包含一个或多个格式项的 复合格式字符串 调用该方法。 为每个格式项分配一个数字索引;第一个索引从 0 开始。 除了初始字符串，方法调用应具有与索引值一样多的其他参数。 例如，格式项的索引为 0 和 1 的字符串应具有 2 个参数;索引为 0 到 5 的 1 个参数应具有 6 个参数。 然后，语言编译器会将方法调用解析为 String.Format 方法的特定重载。

有关使用 String.Format 方法的更详细文档，请参阅 String.Format 方法入门 和 我调用哪种方法？。

Format(String, Object[])

Source:

String.Manipulation.cs

将指定字符串中的格式项替换为指定数组中相应对象的字符串表示形式。

C#

public static string Format (string format, params object?[] args);

参数

format

String

复合格式字符串。

args

Object[]

包含要设置格式的零个或多个对象的对象数组。

返回

String

format 的副本，其中格式项已替换为 args中相应对象的字符串表示形式。

例外

ArgumentNullException

format 或 argsnull。

FormatException

format 无效。

-或-

格式项的索引小于零，或大于或等于 args 数组的长度。

注解

重要

如果语言支持字符串，则可以使用 内插字符串，而不是调用 String.Format 方法或使用 复合格式字符串。 内插字符串是一个字符串，其中包含 内插表达式。 每个内插表达式都使用表达式的值解析，并在分配字符串时包含在结果字符串中。 有关详细信息，请参阅 字符串内插（C# 参考） 和 内插字符串（Visual Basic 参考）。

此方法使用 复合格式设置功能 将四个或多个表达式的值转换为其字符串表示形式，并将这些表示形式嵌入字符串中。 由于 args 参数使用 System.ParamArrayAttribute 属性进行标记，因此可以将对象作为单个参数或 Object 数组传递给该方法。

但是，在调用 String.Format 方法时，不必专注于要调用的特定重载。 相反，可以使用包含一个或多个格式项的 复合格式字符串 调用该方法。 为每个格式项分配一个数字索引;第一个索引从 0 开始。 除了初始字符串，方法调用应具有与索引值一样多的其他参数。 例如，格式项的索引为 0 和 1 的字符串应具有 2 个参数;索引为 0 到 5 的 1 个参数应具有 6 个参数。 然后，语言编译器会将方法调用解析为 String.Format 方法的特定重载。

有关使用 String.Format 方法的更详细文档，请参阅 String.Format 方法入门 和 我调用哪种方法？。

示例：设置三个以上的参数的格式

此示例创建一个字符串，其中包含特定日期的高温和低温数据。 复合格式字符串在 C# 示例中有五个格式项，Visual Basic 示例中有 6 个格式项。 其中两个格式项定义其相应值的字符串表示形式的宽度，第一个格式项还包括标准日期和时间格式字符串。

C#

DateTime date1 = new DateTime(2009, 7, 1);
TimeSpan hiTime = new TimeSpan(14, 17, 32);
decimal hiTemp = 62.1m; 
TimeSpan loTime = new TimeSpan(3, 16, 10);
decimal loTemp = 54.8m; 

string result1 = String.Format("Temperature on {0:d}:\n{1,11}: {2} degrees (hi)\n{3,11}: {4} degrees (lo)", 
                               date1, hiTime, hiTemp, loTime, loTemp);
Console.WriteLine(result1);
Console.WriteLine();
     
string result2 = String.Format("Temperature on {0:d}:\n{1,11}: {2} degrees (hi)\n{3,11}: {4} degrees (lo)", 
                               new object[] { date1, hiTime, hiTemp, loTime, loTemp });
Console.WriteLine(result2);
// The example displays output like the following:
//       Temperature on 7/1/2009:
//          14:17:32: 62.1 degrees (hi)
//          03:16:10: 54.8 degrees (lo)
//       Temperature on 7/1/2009:
//          14:17:32: 62.1 degrees (hi)
//          03:16:10: 54.8 degrees (lo)

还可以传递要格式化为数组而不是参数列表的对象。

C#

using System;

public class CityInfo
{
   public CityInfo(String name, int population, Decimal area, int year)
   {
      this.Name = name;
      this.Population = population;
      this.Area = area;
      this.Year = year;
   }
   
   public readonly String Name; 
   public readonly int Population;
   public readonly Decimal Area;
   public readonly int Year;
}

public class Example
{
   public static void Main()
   {
      CityInfo nyc2010 = new CityInfo("New York", 8175133, 302.64m, 2010);
      ShowPopulationData(nyc2010);
      CityInfo sea2010 = new CityInfo("Seattle", 608660, 83.94m, 2010);      
      ShowPopulationData(sea2010); 
   }

   private static void ShowPopulationData(CityInfo city)
   {
      object[] args = { city.Name, city.Year, city.Population, city.Area };
      String result = String.Format("{0} in {1}: Population {2:N0}, Area {3:N1} sq. feet", 
                                    args);
      Console.WriteLine(result); 
   }
}
// The example displays the following output:
//       New York in 2010: Population 8,175,133, Area 302.6 sq. feet
//       Seattle in 2010: Population 608,660, Area 83.9 sq. feet

另请参阅

• .NET 中的格式设置类型
• 复合格式设置
• 标准日期和时间格式字符串
• 自定义日期和时间格式字符串
• 标准数字格式字符串
• 自定义数字格式字符串
• 标准 TimeSpan 格式字符串
• 自定义 TimeSpan 格式字符串
• 枚举格式字符串

Format(String, Object)

Source:

String.Manipulation.cs

将字符串中的一个或多个格式项替换为指定对象的字符串表示形式。

C#

public static string Format (string format, object? arg0);

参数

format

String

复合格式字符串。

arg0

Object

要设置格式的对象。

返回

String

format 的副本，其中任何格式项都替换为 arg0的字符串表示形式。

例外

ArgumentNullException

format null。

FormatException

format 中的格式项无效。

-或-

格式项的索引不为零。

注解

重要

如果语言支持字符串，则可以使用 内插字符串，而不是调用 String.Format 方法或使用 复合格式字符串。 内插字符串是一个字符串，其中包含 内插表达式。 每个内插表达式都使用表达式的值解析，并在分配字符串时包含在结果字符串中。 有关详细信息，请参阅 字符串内插（C# 参考） 和 内插字符串（Visual Basic 参考）。

此方法使用 复合格式设置功能 将表达式的值转换为其字符串表示形式，并将该表示形式嵌入字符串中。

但是，在调用 String.Format 方法时，不必专注于要调用的特定重载。 相反，可以使用包含一个或多个格式项的 复合格式字符串 调用该方法。 为每个格式项分配一个数字索引;第一个索引从 0 开始。 除了初始字符串，方法调用应具有与索引值一样多的其他参数。 例如，格式项的索引为 0 和 1 的字符串应具有 2 个参数;索引为 0 到 5 的 1 个参数应具有 6 个参数。 然后，语言编译器会将方法调用解析为 String.Format 方法的特定重载。

有关使用 String.Format 方法的更详细文档，请参阅 String.Format 方法入门 和 我调用哪种方法？。

示例：设置单个参数的格式

以下示例使用 Format(String, Object) 方法在字符串中间嵌入个人年龄。

C#

DateTime birthdate = new DateTime(1993, 7, 28);
DateTime[] dates = { new DateTime(1993, 8, 16), 
                     new DateTime(1994, 7, 28), 
                     new DateTime(2000, 10, 16), 
                     new DateTime(2003, 7, 27), 
                     new DateTime(2007, 5, 27) };

foreach (DateTime dateValue in dates)
{
   TimeSpan interval = dateValue - birthdate;
   // Get the approximate number of years, without accounting for leap years.
   int years = ((int) interval.TotalDays) / 365;
   // See if adding the number of years exceeds dateValue.
   string output;
   if (birthdate.AddYears(years) <= dateValue) {
      output = String.Format("You are now {0} years old.", years);
      Console.WriteLine(output);
   }   
   else {
      output = String.Format("You are now {0} years old.", years - 1);
      Console.WriteLine(output);
   }      
}
// The example displays the following output:
//       You are now 0 years old.
//       You are now 1 years old.
//       You are now 7 years old.
//       You are now 9 years old.
//       You are now 13 years old.

另请参阅

• .NET 中的格式设置类型
• 复合格式设置
• 标准日期和时间格式字符串
• 自定义日期和时间格式字符串
• 标准数字格式字符串
• 自定义数字格式字符串
• 标准 TimeSpan 格式字符串
• 自定义 TimeSpan 格式字符串
• 枚举格式字符串

Format(IFormatProvider, CompositeFormat, Object[])

Source:

String.Manipulation.cs

将 CompositeFormat 中的格式项或项替换为指定格式中相应对象的字符串表示形式。

C#

public static string Format (IFormatProvider? provider, System.Text.CompositeFormat format, params object?[] args);

参数

provider

IFormatProvider

提供区域性特定的格式设置信息的对象。

format

CompositeFormat

CompositeFormat。

args

Object[]

要设置格式的对象数组。

返回

String

带格式的字符串。

例外

ArgumentNullException

format 或 argsnull。

FormatException

格式项的索引大于或等于提供的参数数。

Format<TArg0,TArg1,TArg2>(IFormatProvider, CompositeFormat, TArg0, TArg1, TArg2)

Source:

String.Manipulation.cs

将 CompositeFormat 中的格式项或项替换为指定格式中相应对象的字符串表示形式。

C#

public static string Format<TArg0,TArg1,TArg2> (IFormatProvider? provider, System.Text.CompositeFormat format, TArg0 arg0, TArg1 arg1, TArg2 arg2);

类型参数

TArg0

要设置格式的第一个对象的类型。

TArg1

要设置格式的第二个对象的类型。

TArg2

要设置格式的第三个对象的类型。

参数

provider

IFormatProvider

提供区域性特定的格式设置信息的对象。

format

CompositeFormat

CompositeFormat。

arg0

TArg0

要设置格式的第一个对象。

arg1

TArg1

要设置格式的第二个对象。

arg2

TArg2

要设置格式的第三个对象。

返回

String

带格式的字符串。

例外

ArgumentNullException

format null。

FormatException

格式项的索引大于或等于提供的参数数。

Format<TArg0,TArg1>(IFormatProvider, CompositeFormat, TArg0, TArg1)

Source:

String.Manipulation.cs

将 CompositeFormat 中的格式项或项替换为指定格式中相应对象的字符串表示形式。

C#

public static string Format<TArg0,TArg1> (IFormatProvider? provider, System.Text.CompositeFormat format, TArg0 arg0, TArg1 arg1);

类型参数

TArg0

要设置格式的第一个对象的类型。

TArg1

要设置格式的第二个对象的类型。

参数

provider

IFormatProvider

提供区域性特定的格式设置信息的对象。

format

CompositeFormat

CompositeFormat。

arg0

TArg0

要设置格式的第一个对象。

arg1

TArg1

要设置格式的第二个对象。

返回

String

带格式的字符串。

例外

ArgumentNullException

format null。

FormatException

格式项的索引大于或等于提供的参数数。

Format<TArg0>(IFormatProvider, CompositeFormat, TArg0)

Source:

String.Manipulation.cs

将 CompositeFormat 中的格式项或项替换为指定格式中相应对象的字符串表示形式。

C#

public static string Format<TArg0> (IFormatProvider? provider, System.Text.CompositeFormat format, TArg0 arg0);

类型参数

TArg0

要设置格式的第一个对象的类型。

参数

provider

IFormatProvider

提供区域性特定的格式设置信息的对象。

format

CompositeFormat

CompositeFormat。

arg0

TArg0

要设置格式的第一个对象。

返回

String

带格式的字符串。

例外

ArgumentNullException

format null。

FormatException

格式项的索引大于或等于提供的参数数。