ICustomFormatter.Format メソッド

指定した書式およびカルチャ固有の書式情報を使用して、指定したオブジェクトの値をそれと等価な文字列形式に変換します。

Function Format( _
   ByVal format As String, _   ByVal arg As Object, _   ByVal formatProvider As IFormatProvider _) As String
[C#]
string Format(
   stringformat,objectarg,IFormatProviderformatProvider);
[C++]
String* Format(
   String* format,Object* arg,IFormatProvider* formatProvider);
[JScript]
function Format(
   format : String,arg : Object,formatProvider : IFormatProvider) : String;

パラメータ

  • format
    書式指定を格納している書式指定文字列。
  • arg
    書式指定するオブジェクト。
  • formatProvider
    現在のインスタンスについての書式情報を提供する IFormatProvider オブジェクト。

戻り値

formatformatProvider の指定に従って書式指定した arg の値の文字列形式。

解説

format パラメータには、ユーザー定義書式が指定されています。標準 .NET Framework 書式指定の詳細については、「 書式設定の概要 」を参照してください。

format が null 参照 (Visual Basic では Nothing) の場合は、選択される既定の書式指定を使用します。 formatProvider が null 参照 (Nothing) の場合は、そのパラメータを無視します。

.NET Framework がサポートされていない書式指定を提供できるように、 Format メソッドの実装には、次の機能を含む必要があります。書式指定メソッドが書式をサポートしていない場合は、書式指定されているオブジェクトが IFormattable インターフェイスを実装するかどうかを決定します。実装している場合は、そのインターフェイスの IFormattable.ToString メソッドを呼び出します。実装していない場合は、基になるオブジェクトの既定の Object.ToString メソッドを呼び出します。

オブジェクト arg 、書式 format 、書式プロバイダ formatProvider 、および戻り値 s について、このパターンを示す C# コードの一部を次に示します。

if (arg is IFormattable) s = ((IFormattable)arg).ToString(format, formatProvider);

else if (arg != null) s = arg.ToString();

必要条件

**プラットフォーム: **Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 ファミリ, .NET Compact Framework - Windows CE .NET

参照

ICustomFormatter インターフェイス | ICustomFormatter メンバ | System 名前空間 | IFormattable | Object