StringBuilder.AppendFormat メソッド (String, Object )

  • [アーティクル]

0 個以上の書式指定を含んでいる書式付き文字列をこのインスタンスに追加します。各書式指定は、対応するオブジェクト引数の文字列形式に置換されます。

Overloads Public Function AppendFormat( _
   ByVal format As String, _   ByVal ParamArray args() As Object _) As StringBuilder
[C#]
public StringBuilder AppendFormat(stringformat,   params object[] args);
[C++]
public: StringBuilder* AppendFormat(String* format,Object* args __gc[]);
[JScript]
public function AppendFormat(
   format : String,args : Object[]) : StringBuilder;

パラメータ

  • format
    0 個以上の書式指定を含んでいる文字列。
  • args
    書式指定するオブジェクトの配列。

戻り値

format が追加されたこのインスタンスへの参照。 format の書式指定は、対応するオブジェクト引数の文字列形式に置換されます。

例外

例外の種類 条件
ArgumentNullException format または args が null 参照 (Visual Basic では Nothing) です。
FormatException format が無効です。
ArgumentOutOfRangeException このインスタンスの値を増やすと、 MaxCapacity を超えます。

解説

書式指定は、文字列内に {N:FormatString} の形式で埋め込まれています。N は書式指定する引数を示す 0 から始まる番号であり、FormatString は書式指定文字列です。args[N] が IFormattable を実装している場合は、args[N].Format (format, null 参照 (Visual Basic では Nothing)) によって書式指定が行われます。それ以外の場合は、 ToString によって書式指定が行われます。args[N] が null 参照 (Nothing) の場合は、代わりに空の文字列が使用されます。

空白文字を埋め込むには、書式付きの値を右または左に揃えることができる、文字列引数内の領域を定義します。書式指定には、オプションの整数フィールド、{N[,M]:FormatString} があります。M の大きさは、領域の最小空白数を示し、M の符号は、領域内で値が左 (負の値) と右 (正の値) のどちらに位置合わせされるかを示します。

ToString は、書式指定文字列 (Format String) が省略された場合に使用されます。書式指定の中の書式指定文字列は省略できます。書式指定の形式は、{N[,M][:FormatString]} です。FormatString が省略された場合は、N によって指定された引数の ToString メソッドが使用され、書式指定が置き換えられます。M を指定すると、 ToString の結果には、上記のように空白が埋め込まれます。

format に代入された文字列が "Thank you for your purchase of {0:####} copies of MicrosoftR .NET (Core Reference)." で arg[0] が値 123 の Int16 である場合、戻り値は "Thank you for your purchase of 123 copies of MicrosoftR .NET (Core Reference)." になります。

format に代入された文字列が "Brad's dog has {0,-8:G} fleas." で、arg[0] が値 42 の Int16 の場合、戻り値は "Brad's dog has 42______ fleas." になります。なお、この例のアンダースコアは埋め込まれたスペースを表します。

必要条件

プラットフォーム: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 ファミリ, Common Language Infrastructure (CLI) Standard

参照

StringBuilder クラス | StringBuilder メンバ | System.Text 名前空間 | StringBuilder.AppendFormat オーバーロードの一覧 | 書式設定の概要