使用英语阅读

通过


IFormattable.ToString(String, IFormatProvider) 方法

定义

使用指定格式对当前实例的值设置格式。

public string ToString(string format, IFormatProvider formatProvider);
public string ToString(string? format, IFormatProvider? formatProvider);

参数

format
String

要使用的格式。

- 或 -

null 引用(在 Visual Basic 中为 Nothing),用于使用为 IFormattable 实现的类型定义的默认格式。

formatProvider
IFormatProvider

要用于格式化值的提供程序。

- 或 -

null 引用(在 Visual Basic 中为 Nothing),用于从操作系统的当前区域设置获取数字格式信息。

返回

采用指定格式的当前实例的值。

示例

以下示例演示实现 Temperature 方法的 ToString 类。 此代码示例是为 IFormattable 类提供的一个更大示例的一部分。

using System;
using System.Globalization;

public class Temperature : IFormattable
{
   private decimal temp;

   public Temperature(decimal temperature)
   {
      if (temperature < -273.15m)
        throw new ArgumentOutOfRangeException(String.Format("{0} is less than absolute zero.",
                                              temperature));
      this.temp = temperature;
   }

   public decimal Celsius
   {
      get { return temp; }
   }

   public decimal Fahrenheit
   {
      get { return temp * 9 / 5 + 32; }
   }

   public decimal Kelvin
   {
      get { return temp + 273.15m; }
   }

   public override string ToString()
   {
      return this.ToString("G", CultureInfo.CurrentCulture);
   }

   public string ToString(string format)
   {
      return this.ToString(format, CultureInfo.CurrentCulture);
   }

   public string ToString(string format, IFormatProvider provider)
   {
      if (String.IsNullOrEmpty(format)) format = "G";
      if (provider == null) provider = CultureInfo.CurrentCulture;

      switch (format.ToUpperInvariant())
      {
         case "G":
         case "C":
            return temp.ToString("F2", provider) + " °C";
         case "F":
            return Fahrenheit.ToString("F2", provider) + " °F";
         case "K":
            return Kelvin.ToString("F2", provider) + " K";
         default:
            throw new FormatException(String.Format("The {0} format string is not supported.", format));
      }
   }
}

注解

方法 ToString 将值转换为可以通过多种方式表示的字符串表示形式。 其精确格式取决于特定文化、职业或行业定义的特定符号或指定顺序。 可以直接调用 方法。 它还由 Convert.ToString(Object)Convert.ToString(Object, IFormatProvider) 方法以及.NET Framework中使用复合格式设置功能的方法(如 String.Format(String, Object[])Console.WriteLine(String, Object[])StringBuilder.AppendFormat(String, Object[]))自动调用。 (有关详细信息,请参阅 复合格式设置。)

复合格式设置方法为格式字符串中的每个格式项调用 ToString 方法一次。 传递给 方法的参数取决于调用的特定格式设置方法和格式项的内容,如下所示:

备注

仅当复合格式设置方法未通过格式提供程序传递ICustomFormatter或自定义格式提供程序的 方法返回 null时,Format才会调用对象的ToString实现。

.NET Framework包括三个格式提供程序,它们都实现 IFormatProvider 接口:

  • NumberFormatInfo 提供数字格式设置信息,例如用于小数分隔符和分组分隔符的字符,以及货币值中的货币符号的拼写和放置。

  • DateTimeFormatInfo 提供与日期相关的和时间相关的格式设置信息,例如日期模式中月份、日期和年份的位置。

  • CultureInfo 包含特定区域性中的默认格式设置信息,包括数字格式信息,以及与日期相关的和时间相关的格式设置信息。

此外,还可以定义自己的自定义格式提供程序。

实施者说明

方法 ToString(String, IFormatProvider) 必须支持“G” (常规) 格式说明符。 除了“G”说明符之外,类还可以定义它支持的格式说明符列表。 此外,类必须准备好处理 格式 null说明符。 有关设置代码格式和格式设置的详细信息,请参阅 格式设置类型

适用于

产品 版本
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

另请参阅