StringBuilder.AppendFormat メソッド

定義

名前空間:

System.Text

アセンブリ:

System.Runtime.dll

0 個以上の書式指定項目を含む複合書式指定文字列を処理して返された文字列を、このインスタンスに追加します。 各書式項目は、対応するオブジェクト引数の文字列形式に置き換えられます。

オーバーロード

AppendFormat(IFormatProvider, CompositeFormat, ReadOnlySpan<Object>)	0 個以上の書式指定項目を含む複合書式指定文字列を処理して返された文字列を、このインスタンスに追加します。 各書式指定項目は、指定した書式プロバイダーを使用して、任意の引数の文字列形式に置き換えられます。
AppendFormat(String, Object, Object, Object)	0 個以上の書式指定項目を含む複合書式指定文字列を処理して返された文字列を、このインスタンスに追加します。 各書式指定項目は、3 つの引数の文字列形式に置き換えられます。
AppendFormat(IFormatProvider, String, Object, Object)	0 個以上の書式指定項目を含む複合書式指定文字列を処理して返された文字列を、このインスタンスに追加します。 各書式指定項目は、指定した書式プロバイダーを使用して、2 つの引数の文字列形式に置き換えられます。
AppendFormat(String, Object, Object)	0 個以上の書式指定項目を含む複合書式指定文字列を処理して返された文字列を、このインスタンスに追加します。 各書式項目は、2 つの引数の文字列形式に置き換えられます。
AppendFormat(IFormatProvider, String, Object, Object, Object)	0 個以上の書式指定項目を含む複合書式指定文字列を処理して返された文字列を、このインスタンスに追加します。 各書式指定項目は、指定した書式プロバイダーを使用して、3 つの引数のいずれかの文字列表現に置き換えられます。
AppendFormat(IFormatProvider, CompositeFormat, Object[])	0 個以上の書式指定項目を含む複合書式指定文字列を処理して返された文字列を、このインスタンスに追加します。 各書式指定項目は、指定した書式プロバイダーを使用して、任意の引数の文字列形式に置き換えられます。
AppendFormat(IFormatProvider, String, Object[])	0 個以上の書式指定項目を含む複合書式指定文字列を処理して返された文字列を、このインスタンスに追加します。 各書式項目は、指定された書式プロバイダーを使用して、パラメーター配列内の対応する引数の文字列形式に置き換えられます。
AppendFormat(IFormatProvider, String, Object)	0 個以上の書式指定項目を含む複合書式指定文字列を処理して返された文字列を、このインスタンスに追加します。 各書式指定項目は、指定した書式プロバイダーを使用して、1 つの引数の文字列形式に置き換えられます。
AppendFormat(String, Object[])	0 個以上の書式指定項目を含む複合書式指定文字列を処理して返された文字列を、このインスタンスに追加します。 各書式項目は、パラメーター配列内の対応する引数の文字列形式に置き換えられます。
AppendFormat(String, Object)	0 個以上の書式指定項目を含む複合書式指定文字列を処理して返された文字列を、このインスタンスに追加します。 各書式項目は、1 つの引数の文字列形式に置き換えられます。
AppendFormat<TArg0,TArg1,TArg2>(IFormatProvider, CompositeFormat, TArg0, TArg1, TArg2)	0 個以上の書式指定項目を含む複合書式指定文字列を処理して返された文字列を、このインスタンスに追加します。 各書式指定項目は、指定した書式プロバイダーを使用して、任意の引数の文字列形式に置き換えられます。
AppendFormat<TArg0,TArg1>(IFormatProvider, CompositeFormat, TArg0, TArg1)	0 個以上の書式指定項目を含む複合書式指定文字列を処理して返された文字列を、このインスタンスに追加します。 各書式指定項目は、指定した書式プロバイダーを使用して、任意の引数の文字列形式に置き換えられます。
AppendFormat<TArg0>(IFormatProvider, CompositeFormat, TArg0)	0 個以上の書式指定項目を含む複合書式指定文字列を処理して返された文字列を、このインスタンスに追加します。 各書式指定項目は、指定した書式プロバイダーを使用して、任意の引数の文字列形式に置き換えられます。

AppendFormat(IFormatProvider, CompositeFormat, ReadOnlySpan<Object>)

ソース:

StringBuilder.cs

0 個以上の書式指定項目を含む複合書式指定文字列を処理して返された文字列を、このインスタンスに追加します。 各書式指定項目は、指定した書式プロバイダーを使用して、任意の引数の文字列形式に置き換えられます。

public:
 System::Text::StringBuilder ^ AppendFormat(IFormatProvider ^ provider, System::Text::CompositeFormat ^ format, ReadOnlySpan<System::Object ^> args);

public System.Text.StringBuilder AppendFormat (IFormatProvider? provider, System.Text.CompositeFormat format, ReadOnlySpan<object?> args);

member this.AppendFormat : IFormatProvider * System.Text.CompositeFormat * ReadOnlySpan<obj> -> System.Text.StringBuilder

Public Function AppendFormat (provider As IFormatProvider, format As CompositeFormat, args As ReadOnlySpan(Of Object)) As StringBuilder

パラメーター

provider

IFormatProvider

カルチャ固有の書式設定情報を提供するオブジェクト。

format

CompositeFormat

CompositeFormat.

args

ReadOnlySpan<Object>

書式設定するオブジェクトのスパン。

戻り値

StringBuilder

追加操作が完了した後のこのインスタンスへの参照。

例外

ArgumentNullException

format は nullです。

FormatException

書式指定項目のインデックスは、指定された引数の数以上です。

AppendFormat(String, Object, Object, Object)

ソース:

StringBuilder.cs

0 個以上の書式指定項目を含む複合書式指定文字列を処理して返された文字列を、このインスタンスに追加します。 各書式指定項目は、3 つの引数の文字列形式に置き換えられます。

public:
 System::Text::StringBuilder ^ AppendFormat(System::String ^ format, System::Object ^ arg0, System::Object ^ arg1, System::Object ^ arg2);

public System.Text.StringBuilder AppendFormat (string format, object? arg0, object? arg1, object? arg2);

member this.AppendFormat : string * obj * obj * obj -> System.Text.StringBuilder

Public Function AppendFormat (format As String, arg0 As Object, arg1 As Object, arg2 As Object) As StringBuilder

パラメーター

format

String

複合書式指定文字列。

arg0

Object

書式設定する最初のオブジェクト。

arg1

Object

書式設定する 2 番目のオブジェクト。

arg2

Object

書式設定する 3 番目のオブジェクト。

戻り値

StringBuilder

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

例外

ArgumentNullException

format は nullです。

FormatException

format が無効です。

-又は-

書式指定項目のインデックスが 0 (ゼロ) より小さいか、3 以上です。

ArgumentOutOfRangeException

展開された文字列の長さが MaxCapacityを超えています。

例

次の例では、AppendFormat メソッドを示します。

using namespace System;
using namespace System::Text;
using namespace System::Globalization;
void Show( StringBuilder^ sbs )
{
   Console::WriteLine( sbs );
   sbs->Length = 0;
}

int main()
{
   StringBuilder^ sb = gcnew StringBuilder;
   int var1 = 111;
   float var2 = 2.22F;
   String^ var3 = "abcd";
   array<Object^>^var4 = {3,4.4,(Char)'X'};
   Console::WriteLine();
   Console::WriteLine( "StringBuilder.AppendFormat method:" );
   sb->AppendFormat( "1) {0}", var1 );
   Show( sb );
   sb->AppendFormat( "2) {0}, {1}", var1, var2 );
   Show( sb );
   sb->AppendFormat( "3) {0}, {1}, {2}", var1, var2, var3 );
   Show( sb );
   sb->AppendFormat( "4) {0}, {1}, {2}", var4 );
   Show( sb );
   CultureInfo^ ci = gcnew CultureInfo( "es-ES",true );
   array<Object^>^temp1 = {var2};
   sb->AppendFormat( ci, "5) {0}", temp1 );
   Show( sb );
}

/*
This example produces the following results:

StringBuilder.AppendFormat method:
1) 111
2) 111, 2.22
3) 111, 2.22, abcd
4) 3, 4.4, X
5) 2,22
*/

using System;
using System.Text;
using System.Globalization;

class Sample
{
    static StringBuilder sb = new StringBuilder();

    public static void Main()
    {
    int    var1   = 111;
    float  var2   = 2.22F;
    string var3   = "abcd";
    object[] var4 = {3, 4.4, 'X'};

    Console.WriteLine();
    Console.WriteLine("StringBuilder.AppendFormat method:");
    sb.AppendFormat("1) {0}", var1);
    Show(sb);
    sb.AppendFormat("2) {0}, {1}", var1, var2);
    Show(sb);
    sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3);
    Show(sb);
    sb.AppendFormat("4) {0}, {1}, {2}", var4);
    Show(sb);
    CultureInfo ci = new CultureInfo("es-ES", true);
    sb.AppendFormat(ci, "5) {0}", var2);
    Show(sb);
    }

    public static void Show(StringBuilder sbs)
    {
    Console.WriteLine(sbs.ToString());
    sb.Length = 0;
    }
}
/*
This example produces the following results:

StringBuilder.AppendFormat method:
1) 111
2) 111, 2.22
3) 111, 2.22, abcd
4) 3, 4.4, X
5) 2,22
*/

open System.Text
open System.Globalization

let sb = StringBuilder()

let show (sbs: StringBuilder) =
    printfn $"{sbs}"
    sb.Length <- 0

let var1 = 111
let var2 = 2.22f
let var3 = "abcd"
let var4: obj[] = [| 3; 4.4; 'X' |]

printfn "StringBuilder.AppendFormat method:"
sb.AppendFormat("1) {0}", var1) |> ignore
show sb
sb.AppendFormat("2) {0}, {1}", var1, var2) |> ignore
show sb
sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3) |> ignore
show sb
sb.AppendFormat("4) {0}, {1}, {2}", var4) |> ignore
show sb
let ci = CultureInfo("es-ES", true)
sb.AppendFormat(ci, "5) {0}", var2) |> ignore
show sb

// This example produces the following results:
//       StringBuilder.AppendFormat method:
//       1) 111
//       2) 111, 2.22
//       3) 111, 2.22, abcd
//       4) 3, 4.4, X
//       5) 2,22

Imports System.Text
Imports System.Globalization

Class Sample
   Private Shared sb As New StringBuilder()

   Public Shared Sub Main()
      Dim var1 As Integer = 111
      Dim var2 As Single = 2.22F
      Dim var3 As String = "abcd"
      Dim var4 As Object() =  {3, 4.4, "X"c}
      
      Console.WriteLine()
      Console.WriteLine("StringBuilder.AppendFormat method:")
      sb.AppendFormat("1) {0}", var1)
      Show(sb)
      sb.AppendFormat("2) {0}, {1}", var1, var2)
      Show(sb)
      sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3)
      Show(sb)
      sb.AppendFormat("4) {0}, {1}, {2}", var4)
      Show(sb)
      Dim ci As New CultureInfo("es-ES", True)
      sb.AppendFormat(ci, "5) {0}", var2)
      Show(sb)
   End Sub
   
   Public Shared Sub Show(sbs As StringBuilder)
      Console.WriteLine(sbs.ToString())
      sb.Length = 0
   End Sub
End Class
'
'This example produces the following results:
'
'StringBuilder.AppendFormat method:
'1) 111
'2) 111, 2.22
'3) 111, 2.22, abcd
'4) 3, 4.4, X
'5) 2,22

注釈

このメソッドは、.NET Framework の 複合書式設定機能 を使用して、オブジェクトの値をテキスト表現に変換し、その表現を現在の StringBuilder オブジェクトに埋め込みます。

format パラメーターは、0 個以上のインデックス付きプレースホルダー (書式項目と呼ばれます) が混在する 0 個以上のテキスト実行で構成され、このメソッドのパラメーター リスト内のオブジェクト arg2arg0 に対応します。 書式設定プロセスでは、各書式項目が対応するオブジェクトの文字列形式に置き換えられます。

書式項目の構文は次のとおりです。

{index[,length][:formatString]}

角かっこ内の要素は省略可能です。 次の表では、各要素について説明します。

要素	形容
インデックス	書式設定するオブジェクトのパラメーター リスト内の 0 から始まる位置。 インデックス で指定されたオブジェクトが null場合、書式項目は String.Emptyに置き換えられます。 インデックスの 位置にパラメーターがない場合は、FormatException がスローされます。
、長さ	パラメーターの文字列表現の最小文字数。 正の場合、パラメーターは右揃えになります。負の場合は左揃えになります。
:formatString	パラメーターでサポートされる標準書式指定文字列またはカスタム書式指定文字列。

手記

日付と時刻の値で使用される標準書式指定文字列とカスタム書式指定文字列については、「標準の日時書式指定文字列 およびカスタム日時書式指定文字列を参照してください。 数値と共に使用される標準書式指定文字列とカスタム書式指定文字列については、「標準数値書式指定文字列 の と カスタム数値書式指定文字列の」を参照してください。 列挙型で使用される標準書式指定文字列については、「列挙型書式指定文字列 」を参照してください。

arg0、arg1、および arg2 は、書式設定するオブジェクトを表します。 format の各書式項目は、書式項目のインデックスに応じて、arg0、arg1、または arg2の文字列形式に置き換えられます。 書式項目に formatString が含まれており、args の対応するオブジェクトが IFormattable インターフェイスを実装している場合、argx.ToString(formatString, null) は書式を定義します。ここで、x は引数のインデックスです。 それ以外の場合は、argx.ToString() で書式設定が定義されます。

format に割り当てられた文字列が "{0:####} cans of food to our charitable organization に寄付していただきありがとうございます"、arg0 が値 10 の整数の場合、戻り値は "10 缶の食品を慈善団体に寄付していただきありがとうございます" になります。

注意 (呼び出し元)

.NET Core および .NET Framework 4.0 以降のバージョンでは、StringBuilder(Int32, Int32) コンストラクターを呼び出して StringBuilder オブジェクトをインスタンス化すると、StringBuilder インスタンスの長さと容量の両方が、MaxCapacity プロパティの値を超えて拡張される可能性があります。 これは、Append(String) メソッドと AppendFormat(String, Object) メソッドを呼び出して小さな文字列を追加する場合に特に発生する可能性があります。

こちらもご覧ください

• .NET の 書式設定の種類
• 複合書式 を する
• 標準の数値書式指定文字列 を する
• カスタム数値書式指定文字列 を する
• 標準の日時書式指定文字列 を する
• カスタム日時書式指定文字列 を する
• 標準の TimeSpan 書式指定文字列 を する
• カスタム TimeSpan 書式指定文字列 を する
• 列挙形式の文字列

AppendFormat(IFormatProvider, String, Object, Object)

ソース:

StringBuilder.cs

0 個以上の書式指定項目を含む複合書式指定文字列を処理して返された文字列を、このインスタンスに追加します。 各書式指定項目は、指定した書式プロバイダーを使用して、2 つの引数の文字列形式に置き換えられます。

public:
 System::Text::StringBuilder ^ AppendFormat(IFormatProvider ^ provider, System::String ^ format, System::Object ^ arg0, System::Object ^ arg1);

public System.Text.StringBuilder AppendFormat (IFormatProvider? provider, string format, object? arg0, object? arg1);

member this.AppendFormat : IFormatProvider * string * obj * obj -> System.Text.StringBuilder

Public Function AppendFormat (provider As IFormatProvider, format As String, arg0 As Object, arg1 As Object) As StringBuilder

パラメーター

provider

IFormatProvider

カルチャ固有の書式設定情報を提供するオブジェクト。

format

String

複合書式指定文字列。

arg0

Object

書式設定する最初のオブジェクト。

arg1

Object

書式設定する 2 番目のオブジェクト。

戻り値

StringBuilder

追加操作が完了した後のこのインスタンスへの参照。 追加操作の後、このインスタンスには、操作の前に存在していたデータが格納されます。その後、形式指定が対応するオブジェクト引数の文字列形式に置き換えられる format のコピーによってサフィックスが付けられます。

例外

ArgumentNullException

format は nullです。

FormatException

format が無効です。

-又は-

書式指定項目のインデックスが 0 (ゼロ) 未満か、2 (2) 以上です。

ArgumentOutOfRangeException

展開された文字列の長さが MaxCapacityを超えています。

例

次の例では、AppendFormat(IFormatProvider, String, Object, Object) メソッドを使用して、ジェネリック Dictionary<TKey,TValue> オブジェクトに格納されている時間と温度のデータを表示します。 書式指定文字列には 3 つの書式項目がありますが、書式設定するオブジェクトは 3 つだけであることに注意してください。 これは、リスト内の最初のオブジェクト (日付と時刻の値) が 2 つの書式項目によって使用されるためです。最初の書式項目には時刻が表示され、2 番目のオブジェクトには日付が表示されます。

using System;
using System.Collections.Generic;
using System.Globalization;
using System.Text;

public class Example
{
   public static void Main()
   {
      CultureInfo culture = new CultureInfo("en-US");
      StringBuilder sb = new StringBuilder();
      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);

      sb.AppendLine("Temperature Information:\n");
      foreach (var item in temperatureInfo)
      {
         sb.AppendFormat(culture,
                         "Temperature at {0,8:t} on {0,9:d}: {1,5:N1}°F\n",
                         item.Key, item.Value);
      }
      Console.WriteLine(sb.ToString());
   }
}
// The example displays the following output:
//       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

open System
open System.Collections.Generic
open System.Globalization
open System.Text

let culture = CultureInfo "en-US"
let sb = StringBuilder()
let temperatureInfo = Dictionary<DateTime, Double>()
temperatureInfo.Add(DateTime(2010, 6, 1, 14, 0, 0), 87.46)
temperatureInfo.Add(DateTime(2010, 12, 1, 10, 0, 0), 36.81)

sb.AppendLine "Temperature Information:\n" |> ignore

for item in temperatureInfo do
    sb.AppendFormat(culture, "Temperature at {0,8:t} on {0,9:d}: {1,5:N1}°F\n", item.Key, item.Value)
    |> ignore

printfn $"{sb}"

// The example displays the following output:
//       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

Imports System.Collections.Generic
Imports System.Globalization
Imports System.Text

Module Example
   Public Sub Main()
      Dim culture As New CultureInfo("en-US")
      Dim sb As New StringBuilder()
      Dim temperatureInfo As New Dictionary(Of Date, Double) 
      temperatureInfo.Add(#6/1/2010 2:00PM#, 87.46)
      temperatureInfo.Add(#12/1/2010 10:00AM#, 36.81)
      
      sb.AppendLine("Temperature Information:").AppendLine()
      For Each item In temperatureInfo
         sb.AppendFormat(culture,
                         "Temperature at {0,8:t} on {0,9:d}: {1,5:N1}°F",
                         item.Key, item.Value).AppendLine()
      Next
      Console.WriteLine(sb.ToString())
   End Sub
End Module
' The example displays the following output:
'       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 Framework の 複合書式設定機能 を使用して、オブジェクトの値をテキスト表現に変換し、その表現を現在の StringBuilder オブジェクトに埋め込みます。

format パラメーターは、このメソッドのパラメーター リスト内のオブジェクトに対応する、0 個以上のインデックス付きプレースホルダー (書式項目と呼ばれます) が混在する 0 個以上のテキスト実行で構成されます。 書式設定プロセスでは、各書式項目が対応するオブジェクトの文字列形式に置き換えられます。

書式項目の構文は次のとおりです。

{index[,length][:formatString]}

角かっこ内の要素は省略可能です。 次の表では、各要素について説明します。

要素	形容
インデックス	書式設定するオブジェクトのパラメーター リスト内の 0 から始まる位置。 インデックス で指定されたオブジェクトが null場合、書式項目は String.Emptyに置き換えられます。 インデックスの 位置にパラメーターがない場合は、FormatException がスローされます。
、長さ	パラメーターの文字列表現の最小文字数。 正の場合、パラメーターは右揃えになります。負の場合は左揃えになります。
:formatString	パラメーターでサポートされる標準書式指定文字列またはカスタム書式指定文字列。

手記

日付と時刻の値で使用される標準書式指定文字列とカスタム書式指定文字列については、「標準の日時書式指定文字列 およびカスタム日時書式指定文字列を参照してください。 数値と共に使用される標準書式指定文字列とカスタム書式指定文字列については、「標準数値書式指定文字列 の と カスタム数値書式指定文字列の」を参照してください。 列挙型で使用される標準書式指定文字列については、「列挙型書式指定文字列 」を参照してください。

provider パラメーターは、arg0 と arg1の書式設定情報を提供できる IFormatProvider 実装を指定します。 provider には、次のいずれかを指定できます。

• カルチャ固有の書式設定情報を提供する CultureInfo オブジェクト。

• arg0 のカルチャ固有の書式設定情報を提供する NumberFormatInfo オブジェクト。数値の場合は arg1。

• arg0 のカルチャ固有の書式設定情報を提供する DateTimeFormatInfo オブジェクト。日付と時刻の値である場合は arg1。

• arg0 と arg1の書式設定情報を提供するカスタム IFormatProvider 実装。 通常、このような実装では、ICustomFormatter インターフェイスも実装されます。

provider パラメーターが nullされている場合、書式プロバイダー情報は現在のカルチャから取得されます。

arg0 と arg1 は、書式設定するオブジェクトを表します。 format の各書式項目は、対応するインデックスを持つオブジェクトの文字列形式に置き換えられます。 書式項目に formatString が含まれており、対応する引数が IFormattable インターフェイスを実装している場合、引数の ToString(formatString, provider) メソッドによって書式設定が定義されます。 それ以外の場合は、引数の ToString() メソッドによって書式設定が定義されます。

注意 (呼び出し元)

IIn .NET Core および .NET Framework 4.0 以降のバージョンでは、StringBuilder(Int32, Int32) コンストラクターを呼び出して StringBuilder オブジェクトをインスタンス化すると、StringBuilder インスタンスの長さと容量の両方が、MaxCapacity プロパティの値を超えて拡張される可能性があります。 これは、Append(String) メソッドと AppendFormat(String, Object) メソッドを呼び出して小さな文字列を追加する場合に特に発生する可能性があります。

こちらもご覧ください

• .NET の 書式設定の種類
• 複合書式 を する
• 方法: カスタム数値書式プロバイダーを定義して使用する
• 標準の数値書式指定文字列 を する
• カスタム数値書式指定文字列 を する
• 標準の日時書式指定文字列 を する
• カスタム日時書式指定文字列 を する
• 標準の TimeSpan 書式指定文字列 を する
• カスタム TimeSpan 書式指定文字列 を する
• 列挙形式の文字列

AppendFormat(String, Object, Object)

ソース:

StringBuilder.cs

0 個以上の書式指定項目を含む複合書式指定文字列を処理して返された文字列を、このインスタンスに追加します。 各書式項目は、2 つの引数の文字列形式に置き換えられます。

public:
 System::Text::StringBuilder ^ AppendFormat(System::String ^ format, System::Object ^ arg0, System::Object ^ arg1);

public System.Text.StringBuilder AppendFormat (string format, object? arg0, object? arg1);

member this.AppendFormat : string * obj * obj -> System.Text.StringBuilder

Public Function AppendFormat (format As String, arg0 As Object, arg1 As Object) As StringBuilder

パラメーター

format

String

複合書式指定文字列。

arg0

Object

書式設定する最初のオブジェクト。

arg1

Object

書式設定する 2 番目のオブジェクト。

戻り値

StringBuilder

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

例外

ArgumentNullException

format は nullです。

FormatException

format が無効です。

-又は-

書式指定項目のインデックスが 0 (ゼロ) 未満であるか、2 以上です。

ArgumentOutOfRangeException

展開された文字列の長さが MaxCapacityを超えています。

例

次の例では、AppendFormat メソッドを示します。

using namespace System;
using namespace System::Text;
using namespace System::Globalization;
void Show( StringBuilder^ sbs )
{
   Console::WriteLine( sbs );
   sbs->Length = 0;
}

int main()
{
   StringBuilder^ sb = gcnew StringBuilder;
   int var1 = 111;
   float var2 = 2.22F;
   String^ var3 = "abcd";
   array<Object^>^var4 = {3,4.4,(Char)'X'};
   Console::WriteLine();
   Console::WriteLine( "StringBuilder.AppendFormat method:" );
   sb->AppendFormat( "1) {0}", var1 );
   Show( sb );
   sb->AppendFormat( "2) {0}, {1}", var1, var2 );
   Show( sb );
   sb->AppendFormat( "3) {0}, {1}, {2}", var1, var2, var3 );
   Show( sb );
   sb->AppendFormat( "4) {0}, {1}, {2}", var4 );
   Show( sb );
   CultureInfo^ ci = gcnew CultureInfo( "es-ES",true );
   array<Object^>^temp1 = {var2};
   sb->AppendFormat( ci, "5) {0}", temp1 );
   Show( sb );
}

/*
This example produces the following results:

StringBuilder.AppendFormat method:
1) 111
2) 111, 2.22
3) 111, 2.22, abcd
4) 3, 4.4, X
5) 2,22
*/

using System;
using System.Text;
using System.Globalization;

class Sample
{
    static StringBuilder sb = new StringBuilder();

    public static void Main()
    {
    int    var1   = 111;
    float  var2   = 2.22F;
    string var3   = "abcd";
    object[] var4 = {3, 4.4, 'X'};

    Console.WriteLine();
    Console.WriteLine("StringBuilder.AppendFormat method:");
    sb.AppendFormat("1) {0}", var1);
    Show(sb);
    sb.AppendFormat("2) {0}, {1}", var1, var2);
    Show(sb);
    sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3);
    Show(sb);
    sb.AppendFormat("4) {0}, {1}, {2}", var4);
    Show(sb);
    CultureInfo ci = new CultureInfo("es-ES", true);
    sb.AppendFormat(ci, "5) {0}", var2);
    Show(sb);
    }

    public static void Show(StringBuilder sbs)
    {
    Console.WriteLine(sbs.ToString());
    sb.Length = 0;
    }
}
/*
This example produces the following results:

StringBuilder.AppendFormat method:
1) 111
2) 111, 2.22
3) 111, 2.22, abcd
4) 3, 4.4, X
5) 2,22
*/

open System.Text
open System.Globalization

let sb = StringBuilder()

let show (sbs: StringBuilder) =
    printfn $"{sbs}"
    sb.Length <- 0

let var1 = 111
let var2 = 2.22f
let var3 = "abcd"
let var4: obj[] = [| 3; 4.4; 'X' |]

printfn "StringBuilder.AppendFormat method:"
sb.AppendFormat("1) {0}", var1) |> ignore
show sb
sb.AppendFormat("2) {0}, {1}", var1, var2) |> ignore
show sb
sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3) |> ignore
show sb
sb.AppendFormat("4) {0}, {1}, {2}", var4) |> ignore
show sb
let ci = CultureInfo("es-ES", true)
sb.AppendFormat(ci, "5) {0}", var2) |> ignore
show sb

// This example produces the following results:
//       StringBuilder.AppendFormat method:
//       1) 111
//       2) 111, 2.22
//       3) 111, 2.22, abcd
//       4) 3, 4.4, X
//       5) 2,22

Imports System.Text
Imports System.Globalization

Class Sample
   Private Shared sb As New StringBuilder()

   Public Shared Sub Main()
      Dim var1 As Integer = 111
      Dim var2 As Single = 2.22F
      Dim var3 As String = "abcd"
      Dim var4 As Object() =  {3, 4.4, "X"c}
      
      Console.WriteLine()
      Console.WriteLine("StringBuilder.AppendFormat method:")
      sb.AppendFormat("1) {0}", var1)
      Show(sb)
      sb.AppendFormat("2) {0}, {1}", var1, var2)
      Show(sb)
      sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3)
      Show(sb)
      sb.AppendFormat("4) {0}, {1}, {2}", var4)
      Show(sb)
      Dim ci As New CultureInfo("es-ES", True)
      sb.AppendFormat(ci, "5) {0}", var2)
      Show(sb)
   End Sub
   
   Public Shared Sub Show(sbs As StringBuilder)
      Console.WriteLine(sbs.ToString())
      sb.Length = 0
   End Sub
End Class
'
'This example produces the following results:
'
'StringBuilder.AppendFormat method:
'1) 111
'2) 111, 2.22
'3) 111, 2.22, abcd
'4) 3, 4.4, X
'5) 2,22

注釈

このメソッドは、.NET Framework の 複合書式設定機能 を使用して、オブジェクトの値をテキスト表現に変換し、その表現を現在の StringBuilder オブジェクトに埋め込みます。

format パラメーターは、このメソッドのパラメーター リストの 2 つのオブジェクトである、arg0 と arg1に対応する、0 個以上のインデックス付きプレースホルダー (書式項目と呼ばれます) が混在する 0 個以上のテキスト実行で構成されます。 書式設定プロセスでは、各書式項目が対応するオブジェクトの文字列形式に置き換えられます。

書式項目の構文は次のとおりです。

{index[,length][:formatString]}

角かっこ内の要素は省略可能です。 次の表では、各要素について説明します。

要素	形容
インデックス	書式設定するオブジェクトのパラメーター リスト内の 0 から始まる位置。 インデックス で指定されたオブジェクトが null場合、書式項目は String.Emptyに置き換えられます。 インデックスの 位置にパラメーターがない場合は、FormatException がスローされます。
、長さ	パラメーターの文字列表現の最小文字数。 正の場合、パラメーターは右揃えになります。負の場合は左揃えになります。
:formatString	パラメーターでサポートされる標準書式指定文字列またはカスタム書式指定文字列。

手記

日付と時刻の値で使用される標準書式指定文字列とカスタム書式指定文字列については、「標準の日時書式指定文字列 およびカスタム日時書式指定文字列を参照してください。 数値と共に使用される標準書式指定文字列とカスタム書式指定文字列については、「標準数値書式指定文字列 の と カスタム数値書式指定文字列の」を参照してください。 列挙型で使用される標準書式指定文字列については、「列挙型書式指定文字列 」を参照してください。

arg0 と arg1 は、書式設定するオブジェクトを表します。 format 内の各書式指定項目は、arg0 または arg1の文字列形式に置き換えられます。 書式項目に formatString が含まれており、対応するオブジェクトが IFormattable インターフェイスを実装している場合、argx.ToString(formatString, provider) は書式を定義します。ここで、x は引数のインデックスです。 それ以外の場合は、argx.ToString() で書式設定が定義されます。

format に割り当てられた文字列が "{0:####} cans of food to our charitable organization に寄付していただきありがとうございます"、arg0 が値 10 の整数の場合、戻り値は "10 缶の食品を慈善団体に寄付していただきありがとうございます" になります。

注意 (呼び出し元)

.NET Core および .NET Framework 4.0 以降のバージョンでは、StringBuilder(Int32, Int32) コンストラクターを呼び出して StringBuilder オブジェクトをインスタンス化すると、StringBuilder インスタンスの長さと容量の両方が、MaxCapacity プロパティの値を超えて拡張される可能性があります。 これは、Append(String) メソッドと AppendFormat(String, Object) メソッドを呼び出して小さな文字列を追加する場合に特に発生する可能性があります。

こちらもご覧ください

• .NET の 書式設定の種類
• 複合書式 を する
• 標準の数値書式指定文字列 を する
• カスタム数値書式指定文字列 を する
• 標準の日時書式指定文字列 を する
• カスタム日時書式指定文字列 を する
• 標準の TimeSpan 書式指定文字列 を する
• カスタム TimeSpan 書式指定文字列 を する
• 列挙形式の文字列

AppendFormat(IFormatProvider, String, Object, Object, Object)

ソース:

StringBuilder.cs

0 個以上の書式指定項目を含む複合書式指定文字列を処理して返された文字列を、このインスタンスに追加します。 各書式指定項目は、指定した書式プロバイダーを使用して、3 つの引数のいずれかの文字列表現に置き換えられます。

public:
 System::Text::StringBuilder ^ AppendFormat(IFormatProvider ^ provider, System::String ^ format, System::Object ^ arg0, System::Object ^ arg1, System::Object ^ arg2);

public System.Text.StringBuilder AppendFormat (IFormatProvider? provider, string format, object? arg0, object? arg1, object? arg2);

member this.AppendFormat : IFormatProvider * string * obj * obj * obj -> System.Text.StringBuilder

Public Function AppendFormat (provider As IFormatProvider, format As String, arg0 As Object, arg1 As Object, arg2 As Object) As StringBuilder

パラメーター

provider

IFormatProvider

カルチャ固有の書式設定情報を提供するオブジェクト。

format

String

複合書式指定文字列。

arg0

Object

書式設定する最初のオブジェクト。

arg1

Object

書式設定する 2 番目のオブジェクト。

arg2

Object

書式設定する 3 番目のオブジェクト。

戻り値

StringBuilder

追加操作が完了した後のこのインスタンスへの参照。 追加操作の後、このインスタンスには、操作の前に存在していたデータが格納されます。その後、形式指定が対応するオブジェクト引数の文字列形式に置き換えられる format のコピーによってサフィックスが付けられます。

例外

ArgumentNullException

format は nullです。

FormatException

format が無効です。

-又は-

書式指定項目のインデックスが 0 (ゼロ) 未満であるか、3 (3) 以上です。

ArgumentOutOfRangeException

展開された文字列の長さが MaxCapacityを超えています。

例

次の例では、AppendFormat(IFormatProvider, String, Object, Object, Object) メソッドを使用して、整数値を使用したブール And 演算の結果を示します。 書式指定文字列には 6 つの書式指定項目が含まれますが、各アイテムは 2 つの異なる方法で書式設定されるため、メソッドの引数リストには 3 つの項目しか含めないため注意してください。

using System;
using System.Globalization;
using System.Text;

public class Example
{
   public static void Main()
   {
      Random rnd = new Random();
      CultureInfo culture = CultureInfo.CreateSpecificCulture("fr-FR");
      StringBuilder sb = new StringBuilder();
      string formatString = "    {0,12:N0} ({0,8:X8})\n" +
                            "And {1,12:N0} ({1,8:X8})\n" +
                            "  = {2,12:N0} ({2,8:X8})\n";
      for (int ctr = 0; ctr <= 2; ctr++) {
         int value1 = rnd.Next();
         int value2 = rnd.Next();
         sb.AppendFormat(culture, formatString,
                         value1, value2, value1 & value2).
                         AppendLine();
      }
      Console.WriteLine(sb.ToString());
   }
}
// The example displays output like the following:
//           1 984 112 195 (76432643)
//       And 1 179 778 511 (4651FDCF)
//         = 1 178 674 243 (46412443)
//
//           2 034 813 710 (7948CB0E)
//       And  569 333 976 (21EF58D8)
//         =  558 385 160 (21484808)
//
//            126 717 735 (078D8F27)
//       And 1 830 715 973 (6D1E8245)
//         =   84 705 797 (050C8205)

open System
open System.Globalization
open System.Text

let rnd = Random()
let culture = CultureInfo.CreateSpecificCulture "fr-FR"
let sb = StringBuilder()

let formatString =
    "    {0,12:N0} ({0,8:X8})\nAnd {1,12:N0} ({1,8:X8})\n  = {2,12:N0} ({2,8:X8})\n"

for _ = 0 to 2 do
    let value1 = rnd.Next()
    let value2 = rnd.Next()

    sb
        .AppendFormat(culture, formatString, value1, value2, value1 &&& value2)
        .AppendLine()
    |> ignore

printfn $"{sb}"

// The example displays output like the following:
//           1 984 112 195 (76432643)
//       And 1 179 778 511 (4651FDCF)
//         = 1 178 674 243 (46412443)
//
//           2 034 813 710 (7948CB0E)
//       And  569 333 976 (21EF58D8)
//         =  558 385 160 (21484808)
//
//            126 717 735 (078D8F27)
//       And 1 830 715 973 (6D1E8245)
//         =   84 705 797 (050C8205)

Imports System.Globalization
Imports System.Text

Public Module Example
   Public Sub Main()
      Dim rnd As New Random()
      Dim culture As CultureInfo = CultureInfo.CreateSpecificCulture("fr-FR")
      Dim sb As New StringBuilder()
      Dim formatString As String = "    {0,12:N0} ({0,8:X8})" + vbCrLf +
                                   "And {1,12:N0} ({1,8:X8})" + vbCrLf +
                                   "  = {2,12:N0} ({2,8:X8})" + vbCrLf
      For ctr As Integer = 0 To 2
         Dim value1 As Integer = rnd.Next()
         Dim value2 As Integer = rnd.Next()
         sb.AppendFormat(culture, formatString,
                         value1, value2, value1 And value2).AppendLine()
      Next
      Console.WriteLine(sb.ToString())
   End Sub
End Module
' The example displays the following output:
'           1 984 112 195 (76432643)
'       And 1 179 778 511 (4651FDCF)
'         = 1 178 674 243 (46412443)
'
'           2 034 813 710 (7948CB0E)
'       And  569 333 976 (21EF58D8)
'         =  558 385 160 (21484808)
'
'            126 717 735 (078D8F27)
'       And 1 830 715 973 (6D1E8245)
'         =   84 705 797 (050C8205)

注釈

このメソッドは、.NET Framework の 複合書式設定機能 を使用して、オブジェクトの値をテキスト表現に変換し、その表現を現在の StringBuilder オブジェクトに埋め込みます。

format パラメーターは、このメソッドのパラメーター リスト内のオブジェクトに対応する、0 個以上のインデックス付きプレースホルダー (書式項目と呼ばれます) が混在する 0 個以上のテキスト実行で構成されます。 書式設定プロセスでは、各書式項目が対応するオブジェクトの文字列形式に置き換えられます。

書式項目の構文は次のとおりです。

{index[,length][:formatString]}

角かっこ内の要素は省略可能です。 次の表では、各要素について説明します。

要素	形容
インデックス	書式設定するオブジェクトのパラメーター リスト内の 0 から始まる位置。 インデックス で指定されたオブジェクトが null場合、書式項目は String.Emptyに置き換えられます。 インデックスの 位置にパラメーターがない場合は、FormatException がスローされます。
、長さ	パラメーターの文字列表現の最小文字数。 正の場合、パラメーターは右揃えになります。負の場合は左揃えになります。
:formatString	パラメーターでサポートされる標準書式指定文字列またはカスタム書式指定文字列。

手記

日付と時刻の値で使用される標準書式指定文字列とカスタム書式指定文字列については、「標準の日時書式指定文字列 およびカスタム日時書式指定文字列を参照してください。 数値と共に使用される標準書式指定文字列とカスタム書式指定文字列については、「標準数値書式指定文字列 の と カスタム数値書式指定文字列の」を参照してください。 列挙型で使用される標準書式指定文字列については、「列挙型書式指定文字列 」を参照してください。

provider パラメーターは、arg0 と arg1の書式設定情報を提供できる IFormatProvider 実装を指定します。 provider には、次のいずれかを指定できます。

• カルチャ固有の書式設定情報を提供する CultureInfo オブジェクト。

• arg0 のカルチャ固有の書式設定情報を提供する NumberFormatInfo オブジェクト。数値の場合は arg1。

• arg0、arg1、または日付と時刻の値である場合に arg2 のカルチャ固有の書式設定情報を提供する DateTimeFormatInfo オブジェクト。

• arg0、arg1、および arg2の書式設定情報を提供するカスタム IFormatProvider 実装。 通常、このような実装では、ICustomFormatter インターフェイスも実装されます。

provider パラメーターが nullされている場合、書式プロバイダー情報は現在のカルチャから取得されます。

arg0、arg1、および arg2 は、書式設定するオブジェクトを表します。 format の各書式項目は、対応するインデックスを持つオブジェクトの文字列形式に置き換えられます。 書式項目に formatString が含まれており、対応する引数が IFormattable インターフェイスを実装している場合、引数の ToString(formatString, provider) メソッドによって書式設定が定義されます。 それ以外の場合は、引数の ToString() メソッドによって書式設定が定義されます。

注意 (呼び出し元)

.NET Core および .NET Framework 4.0 以降のバージョンでは、StringBuilder(Int32, Int32) コンストラクターを呼び出して StringBuilder オブジェクトをインスタンス化すると、StringBuilder インスタンスの長さと容量の両方が、MaxCapacity プロパティの値を超えて拡張される可能性があります。 これは、Append(String) メソッドと AppendFormat(String, Object) メソッドを呼び出して小さな文字列を追加する場合に特に発生する可能性があります。

こちらもご覧ください

• .NET の 書式設定の種類
• 複合書式 を する
• 方法: カスタム数値書式プロバイダーを定義して使用する
• 標準の数値書式指定文字列 を する
• カスタム数値書式指定文字列 を する
• 標準の日時書式指定文字列 を する
• カスタム日時書式指定文字列 を する
• 標準の TimeSpan 書式指定文字列 を する
• カスタム TimeSpan 書式指定文字列 を する
• 列挙形式の文字列

AppendFormat(IFormatProvider, CompositeFormat, Object[])

ソース:

StringBuilder.cs

0 個以上の書式指定項目を含む複合書式指定文字列を処理して返された文字列を、このインスタンスに追加します。 各書式指定項目は、指定した書式プロバイダーを使用して、任意の引数の文字列形式に置き換えられます。

public:
 System::Text::StringBuilder ^ AppendFormat(IFormatProvider ^ provider, System::Text::CompositeFormat ^ format, ... cli::array <System::Object ^> ^ args);

public System.Text.StringBuilder AppendFormat (IFormatProvider? provider, System.Text.CompositeFormat format, params object?[] args);

member this.AppendFormat : IFormatProvider * System.Text.CompositeFormat * obj[] -> System.Text.StringBuilder

Public Function AppendFormat (provider As IFormatProvider, format As CompositeFormat, ParamArray args As Object()) As StringBuilder

パラメーター

provider

IFormatProvider

カルチャ固有の書式設定情報を提供するオブジェクト。

format

CompositeFormat

CompositeFormat.

args

Object[]

書式設定するオブジェクトの配列。

戻り値

StringBuilder

追加操作が完了した後のこのインスタンスへの参照。

例外

ArgumentNullException

format または args が null。

FormatException

書式指定項目のインデックスは、指定された引数の数以上です。

AppendFormat(IFormatProvider, String, Object[])

ソース:

StringBuilder.cs

0 個以上の書式指定項目を含む複合書式指定文字列を処理して返された文字列を、このインスタンスに追加します。 各書式項目は、指定された書式プロバイダーを使用して、パラメーター配列内の対応する引数の文字列形式に置き換えられます。

public:
 System::Text::StringBuilder ^ AppendFormat(IFormatProvider ^ provider, System::String ^ format, ... cli::array <System::Object ^> ^ args);

public System.Text.StringBuilder AppendFormat (IFormatProvider? provider, string format, params object?[] args);

member this.AppendFormat : IFormatProvider * string * obj[] -> System.Text.StringBuilder

Public Function AppendFormat (provider As IFormatProvider, format As String, ParamArray args As Object()) As StringBuilder

パラメーター

provider

IFormatProvider

カルチャ固有の書式設定情報を提供するオブジェクト。

format

String

複合書式指定文字列。

args

Object[]

書式設定するオブジェクトの配列。

戻り値

StringBuilder

追加操作が完了した後のこのインスタンスへの参照。 追加操作の後、このインスタンスには、操作の前に存在していたデータが格納されます。その後、形式指定が対応するオブジェクト引数の文字列形式に置き換えられる format のコピーによってサフィックスが付けられます。

例外

ArgumentNullException

format は nullです。

FormatException

format が無効です。

-又は-

書式指定項目のインデックスが 0 (ゼロ) 未満であるか、args 配列の長さ以上です。

ArgumentOutOfRangeException

展開された文字列の長さが MaxCapacityを超えています。

例

次の例では、AppendFormat メソッドを示します。

using namespace System;
using namespace System::Text;
using namespace System::Globalization;
void Show( StringBuilder^ sbs )
{
   Console::WriteLine( sbs );
   sbs->Length = 0;
}

int main()
{
   StringBuilder^ sb = gcnew StringBuilder;
   int var1 = 111;
   float var2 = 2.22F;
   String^ var3 = "abcd";
   array<Object^>^var4 = {3,4.4,(Char)'X'};
   Console::WriteLine();
   Console::WriteLine( "StringBuilder.AppendFormat method:" );
   sb->AppendFormat( "1) {0}", var1 );
   Show( sb );
   sb->AppendFormat( "2) {0}, {1}", var1, var2 );
   Show( sb );
   sb->AppendFormat( "3) {0}, {1}, {2}", var1, var2, var3 );
   Show( sb );
   sb->AppendFormat( "4) {0}, {1}, {2}", var4 );
   Show( sb );
   CultureInfo^ ci = gcnew CultureInfo( "es-ES",true );
   array<Object^>^temp1 = {var2};
   sb->AppendFormat( ci, "5) {0}", temp1 );
   Show( sb );
}

/*
This example produces the following results:

StringBuilder.AppendFormat method:
1) 111
2) 111, 2.22
3) 111, 2.22, abcd
4) 3, 4.4, X
5) 2,22
*/

using System;
using System.Text;
using System.Globalization;

class Sample
{
    static StringBuilder sb = new StringBuilder();

    public static void Main()
    {
    int    var1   = 111;
    float  var2   = 2.22F;
    string var3   = "abcd";
    object[] var4 = {3, 4.4, 'X'};

    Console.WriteLine();
    Console.WriteLine("StringBuilder.AppendFormat method:");
    sb.AppendFormat("1) {0}", var1);
    Show(sb);
    sb.AppendFormat("2) {0}, {1}", var1, var2);
    Show(sb);
    sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3);
    Show(sb);
    sb.AppendFormat("4) {0}, {1}, {2}", var4);
    Show(sb);
    CultureInfo ci = new CultureInfo("es-ES", true);
    sb.AppendFormat(ci, "5) {0}", var2);
    Show(sb);
    }

    public static void Show(StringBuilder sbs)
    {
    Console.WriteLine(sbs.ToString());
    sb.Length = 0;
    }
}
/*
This example produces the following results:

StringBuilder.AppendFormat method:
1) 111
2) 111, 2.22
3) 111, 2.22, abcd
4) 3, 4.4, X
5) 2,22
*/

open System.Text
open System.Globalization

let sb = StringBuilder()

let show (sbs: StringBuilder) =
    printfn $"{sbs}"
    sb.Length <- 0

let var1 = 111
let var2 = 2.22f
let var3 = "abcd"
let var4: obj[] = [| 3; 4.4; 'X' |]

printfn "StringBuilder.AppendFormat method:"
sb.AppendFormat("1) {0}", var1) |> ignore
show sb
sb.AppendFormat("2) {0}, {1}", var1, var2) |> ignore
show sb
sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3) |> ignore
show sb
sb.AppendFormat("4) {0}, {1}, {2}", var4) |> ignore
show sb
let ci = CultureInfo("es-ES", true)
sb.AppendFormat(ci, "5) {0}", var2) |> ignore
show sb

// This example produces the following results:
//       StringBuilder.AppendFormat method:
//       1) 111
//       2) 111, 2.22
//       3) 111, 2.22, abcd
//       4) 3, 4.4, X
//       5) 2,22

Imports System.Text
Imports System.Globalization

Class Sample
   Private Shared sb As New StringBuilder()

   Public Shared Sub Main()
      Dim var1 As Integer = 111
      Dim var2 As Single = 2.22F
      Dim var3 As String = "abcd"
      Dim var4 As Object() =  {3, 4.4, "X"c}
      
      Console.WriteLine()
      Console.WriteLine("StringBuilder.AppendFormat method:")
      sb.AppendFormat("1) {0}", var1)
      Show(sb)
      sb.AppendFormat("2) {0}, {1}", var1, var2)
      Show(sb)
      sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3)
      Show(sb)
      sb.AppendFormat("4) {0}, {1}, {2}", var4)
      Show(sb)
      Dim ci As New CultureInfo("es-ES", True)
      sb.AppendFormat(ci, "5) {0}", var2)
      Show(sb)
   End Sub
   
   Public Shared Sub Show(sbs As StringBuilder)
      Console.WriteLine(sbs.ToString())
      sb.Length = 0
   End Sub
End Class
'
'This example produces the following results:
'
'StringBuilder.AppendFormat method:
'1) 111
'2) 111, 2.22
'3) 111, 2.22, abcd
'4) 3, 4.4, X
'5) 2,22

次の例では、10 桁の顧客番号を 4 桁と 7 桁の後にハイフンで書式設定する、CustomerFormatter という名前のカスタム IFormatProvider 実装を定義します。 書式設定された顧客番号と顧客名を含む文字列を作成するために、StringBuilder.AppendFormat(IFormatProvider, String, Object[]) メソッドに渡されます。

using System;
using System.Text;

public class Customer
{
   private string custName;
   private int custNumber;
   
   public Customer(string name, int number)
   {
      this.custName = name;
      this.custNumber = number;
   }
   
   public string Name
   {
      get { return this.custName; }
   }
   
   public int CustomerNumber
   {
      get { return this.custNumber; }
   }
}

public class CustomerNumberFormatter : IFormatProvider, ICustomFormatter
{   
   public object GetFormat(Type formatType)
   {
      if (formatType == typeof(ICustomFormatter))
         return this;
      return null;
   }
   
   public string Format(string format, object arg, IFormatProvider provider)
   {
      if (arg is Int32)
      {
         string custNumber = ((int) arg).ToString("D10");
         return custNumber.Substring(0, 4) + "-" + custNumber.Substring(4, 3) + 
                "-" + custNumber.Substring(7, 3);
      }
      else
      {
         return null;
      }
   }                   
}

public class Example
{
   public static void Main()
   {
      Customer customer = new Customer("A Plus Software", 903654);
      StringBuilder sb = new StringBuilder();
      sb.AppendFormat(new CustomerNumberFormatter(), "{0}: {1}", 
                      customer.CustomerNumber, customer.Name);
      Console.WriteLine(sb.ToString());
   }
}
// The example displays the following output:
//      0000-903-654: A Plus Software

open System
open System.Text

type Customer(name: string, number: int) =
    member _.Name = name
    member _.CustomerNumber = number

type CustomerNumberFormatter() =
    interface IFormatProvider with
        member this.GetFormat(formatType) =
            if formatType = typeof<ICustomFormatter> then this else null

    interface ICustomFormatter with
        member _.Format(_, arg, _) =
            match arg with
            | :? int as i ->
                let custNumber = i.ToString "D10"
                $"{custNumber.Substring(0, 4)}-{custNumber.Substring(4, 3)}-{custNumber.Substring(7, 3)}"
            | _ -> null

let customer = Customer("A Plus Software", 903654)
let sb = StringBuilder()

sb.AppendFormat(CustomerNumberFormatter(), "{0}: {1}", customer.CustomerNumber, customer.Name)
|> ignore

printfn $"{sb}"

// The example displays the following output:
//      0000-903-654: A Plus Software

Imports System.Text

Public Class Customer
   Private custName As String
   Private custNumber As Integer
   
   Public Sub New(name As String, number As Integer)
      custName = name
      custNumber = number
   End Sub
   
   Public ReadOnly Property Name As String
      Get
         Return Me.custName
      End Get
   End Property
   
   Public ReadOnly Property CustomerNumber As Integer
      Get
         Return Me.custNumber
      End Get
   End Property
End Class

Public Class CustomerNumberFormatter 
   Implements IFormatProvider, ICustomFormatter
   
   Public Function GetFormat(formatType As Type) As Object _
                   Implements IFormatProvider.GetFormat
      If formatType Is GetType(ICustomFormatter) Then
         Return Me
      End If
      Return Nothing
   End Function
   
   Public Function Format(fmt As String, arg As Object, provider As IFormatProvider) As String _
                   Implements ICustomFormatter.Format
      If typeof arg Is Int32 Then
         Dim custNumber As String = CInt(arg).ToString("D10")
         Return custNumber.Substring(0, 4) + "-" + custNumber.SubString(4, 3) + _
                "-" + custNumber.Substring(7, 3)
      Else
         Return Nothing
      End If
   End Function                   
End Class

Module Example
   Public Sub Main()
      Dim customer As New Customer("A Plus Software", 903654)
      Dim sb As New StringBuilder()
      sb.AppendFormat(New CustomerNumberFormatter, "{0}: {1}", _
                      customer.CustomerNumber, customer.Name)
      Console.WriteLine(sb.ToString())
   End Sub
End Module
' The example displays the following output:
'      0000-903-654: A Plus Software

注釈

このメソッドは、.NET Framework の 複合書式設定機能 を使用して、オブジェクトの値をテキスト表現に変換し、その表現を現在の StringBuilder オブジェクトに埋め込みます。

format パラメーターは、このメソッドのパラメーター リスト内のオブジェクトに対応する、0 個以上のインデックス付きプレースホルダー (書式項目と呼ばれます) が混在する 0 個以上のテキスト実行で構成されます。 書式設定プロセスでは、各書式項目が対応するオブジェクトの文字列形式に置き換えられます。

書式項目の構文は次のとおりです。

{index[,length][:formatString]}

角かっこ内の要素は省略可能です。 次の表では、各要素について説明します。

要素	形容
インデックス	書式設定するオブジェクトのパラメーター リスト内の 0 から始まる位置。 インデックス で指定されたオブジェクトが null場合、書式項目は String.Emptyに置き換えられます。 インデックスの 位置にパラメーターがない場合は、FormatException がスローされます。
、長さ	パラメーターの文字列表現の最小文字数。 正の場合、パラメーターは右揃えになります。負の場合は左揃えになります。
:formatString	パラメーターでサポートされる標準書式指定文字列またはカスタム書式指定文字列。

手記

日付と時刻の値で使用される標準書式指定文字列とカスタム書式指定文字列については、「標準の日時書式指定文字列 およびカスタム日時書式指定文字列を参照してください。 数値と共に使用される標準書式指定文字列とカスタム書式指定文字列については、「標準数値書式指定文字列 の と カスタム数値書式指定文字列の」を参照してください。 列挙型で使用される標準書式指定文字列については、「列挙型書式指定文字列 」を参照してください。

provider パラメーターは、args内のオブジェクトの書式設定情報を提供できる IFormatProvider 実装を指定します。 provider には、次のいずれかを指定できます。

• カルチャ固有の書式設定情報を提供する CultureInfo オブジェクト。

• argsの数値のカルチャ固有の書式設定情報を提供する NumberFormatInfo オブジェクト。

• argsの日付と時刻の値のカルチャ固有の書式設定情報を提供する DateTimeFormatInfo オブジェクト。

• args内の 1 つ以上のオブジェクトの書式設定情報を提供するカスタム IFormatProvider 実装。 通常、このような実装では、ICustomFormatter インターフェイスも実装されます。 次のセクションの 2 番目の例は、カスタム IFormatProvider 実装を使用した StringBuilder.AppendFormat(IFormatProvider, String, Object[]) メソッド呼び出しを示しています。

provider パラメーターが nullされている場合、書式プロバイダー情報は現在のカルチャから取得されます。

args は、書式設定するオブジェクトを表します。 format の各書式項目は、args内の対応するオブジェクトの文字列形式に置き換えられます。 書式項目に formatString が含まれており、args の対応するオブジェクトが IFormattable インターフェイスを実装している場合は、args[index].ToString(formatString, provider) 書式設定が定義されます。 それ以外の場合は、args[index].ToString() 書式設定を定義します。

注意 (呼び出し元)

.NET Core および .NET Framework 4.0 以降のバージョンでは、StringBuilder(Int32, Int32) コンストラクターを呼び出して StringBuilder オブジェクトをインスタンス化すると、StringBuilder インスタンスの長さと容量の両方が、MaxCapacity プロパティの値を超えて拡張される可能性があります。 これは、Append(String) メソッドと AppendFormat(String, Object) メソッドを呼び出して小さな文字列を追加する場合に特に発生する可能性があります。

こちらもご覧ください

• .NET の 書式設定の種類
• 複合書式 を する
• 方法: カスタム数値書式プロバイダーを定義して使用する
• 標準の数値書式指定文字列 を する
• カスタム数値書式指定文字列 を する
• 標準の日時書式指定文字列 を する
• カスタム日時書式指定文字列 を する
• 標準の TimeSpan 書式指定文字列 を する
• カスタム TimeSpan 書式指定文字列 を する
• 列挙形式の文字列

AppendFormat(IFormatProvider, String, Object)

ソース:

StringBuilder.cs

0 個以上の書式指定項目を含む複合書式指定文字列を処理して返された文字列を、このインスタンスに追加します。 各書式指定項目は、指定した書式プロバイダーを使用して、1 つの引数の文字列形式に置き換えられます。

public:
 System::Text::StringBuilder ^ AppendFormat(IFormatProvider ^ provider, System::String ^ format, System::Object ^ arg0);

public System.Text.StringBuilder AppendFormat (IFormatProvider? provider, string format, object? arg0);

member this.AppendFormat : IFormatProvider * string * obj -> System.Text.StringBuilder

Public Function AppendFormat (provider As IFormatProvider, format As String, arg0 As Object) As StringBuilder

パラメーター

provider

IFormatProvider

カルチャ固有の書式設定情報を提供するオブジェクト。

format

String

複合書式指定文字列。

arg0

Object

書式設定するオブジェクト。

戻り値

StringBuilder

追加操作が完了した後のこのインスタンスへの参照。 追加操作の後、このインスタンスには、操作の前に存在していたデータが格納され、形式指定が arg0の文字列表現に置き換えられる format のコピーによってサフィックスが付けられます。

例外

ArgumentNullException

format は nullです。

FormatException

format が無効です。

-又は-

書式指定項目のインデックスが 0 (ゼロ) より小さいか、1 以上です。

ArgumentOutOfRangeException

展開された文字列の長さが MaxCapacityを超えています。

例

次に、AppendFormat(IFormatProvider, String, Object) メソッドの 2 つの呼び出しを示します。 どちらも、English-United Kingdom (en-GB) カルチャの書式設定規則を使用します。 1 つ目は、結果文字列に Decimal 値の通貨の文字列形式を挿入します。 2 つ目は、結果文字列の 2 つの場所に DateTime 値を挿入します。1 つ目は短い日付文字列のみを含み、2 番目は短い時刻文字列を含みます。

using System;
using System.Globalization;
using System.Text;

public class Example
{
   public static void Main()
   {
      StringBuilder sb = new StringBuilder();
      Decimal value = 16.95m;
      CultureInfo enGB = CultureInfo.CreateSpecificCulture("en-GB");
      DateTime dateToday = DateTime.Now;
      sb.AppendFormat(enGB, "Final Price: {0:C2}", value);
      sb.AppendLine();
      sb.AppendFormat(enGB, "Date and Time: {0:d} at {0:t}", dateToday);
      Console.WriteLine(sb.ToString());
   }
}
// The example displays the following output:
//       Final Price: £16.95
//       Date and Time: 01/10/2014 at 10:22

open System
open System.Globalization
open System.Text

let sb = StringBuilder()
let value = 16.95m
let enGB = CultureInfo.CreateSpecificCulture "en-GB"
let dateToday = DateTime.Now
sb.AppendFormat(enGB, "Final Price: {0:C2}", value) |> ignore
sb.AppendLine() |> ignore
sb.AppendFormat(enGB, "Date and Time: {0:d} at {0:t}", dateToday) |> ignore
printfn $"{sb}"

// The example displays the following output:
//       Final Price: £16.95
//       Date and Time: 01/10/2014 at 10:22

Imports System.Globalization
Imports System.Text

Module Example
   Public Sub Main()
      Dim sb As New StringBuilder()
      Dim value As Decimal = 16.95d
      Dim enGB As CultureInfo = CultureInfo.CreateSpecificCulture("en-GB")
      Dim dateToday As DateTime = Date.Now
      sb.AppendFormat(enGB, "Final Price: {0:C2}", value)
      sb.AppendLine()
      sb.AppendFormat(enGB, "Date and Time: {0:d} at {0:t}", dateToday)
      Console.WriteLine(sb.ToString())
   End Sub
End Module
' The example displays output like the following:
'       Final Price: £16.95
'       Date and Time: 01/10/2014 at 10:22

注釈

このメソッドは、.NET Framework の 複合書式設定機能 を使用して、arg0 の値をテキスト表現に変換し、その表現を現在の StringBuilder オブジェクトに埋め込みます。

format パラメーターは、0 個以上のテキスト実行と、0 個以上のインデックス付きプレースホルダー (書式項目と呼ばれます) で構成されます。 このメソッドには 1 つの引数を持つ引数リストが含まれるため、各書式項目のインデックスはゼロ (0) にする必要があります。 書式設定プロセスでは、各書式項目が arg0の文字列形式に置き換えられます。

書式項目の構文は次のとおりです。

{index[,length][:formatString]}

角かっこ内の要素は省略可能です。 次の表では、各要素について説明します。

要素	形容
インデックス	書式設定するオブジェクトのパラメーター リスト内の 0 から始まる位置。 インデックス で指定されたオブジェクトが null場合、書式項目は String.Emptyに置き換えられます。 この場合、AppendFormat(IFormatProvider, String, Object) メソッドには引数リストに 1 つの引数があるため、インデックス の値は常に 0 である必要があります。 そうでない場合は、FormatException がスローされます。
、長さ	パラメーターの文字列表現の最小文字数。 正の場合、パラメーターは右揃えになります。負の場合は左揃えになります。
:formatString	パラメーターでサポートされる標準書式指定文字列またはカスタム書式指定文字列。

手記

日付と時刻の値で使用される標準書式指定文字列とカスタム書式指定文字列については、「標準の日時書式指定文字列 およびカスタム日時書式指定文字列を参照してください。 数値と共に使用される標準書式指定文字列とカスタム書式指定文字列については、「標準数値書式指定文字列 の と カスタム数値書式指定文字列の」を参照してください。 列挙型で使用される標準書式指定文字列については、「列挙型書式指定文字列 」を参照してください。

provider パラメーターは、args内のオブジェクトの書式設定情報を提供できる IFormatProvider 実装を指定します。 provider には、次のいずれかを指定できます。

• カルチャ固有の書式設定情報を提供する CultureInfo オブジェクト。

• 数値の場合に arg0 のカルチャ固有の書式設定情報を提供する NumberFormatInfo オブジェクト。

• 日付と時刻の値である場合に arg0 のカルチャ固有の書式設定情報を提供する DateTimeFormatInfo オブジェクト。

• arg0の書式設定情報を提供するカスタム IFormatProvider 実装。 通常、このような実装では、ICustomFormatter インターフェイスも実装されます。

provider パラメーターが nullされている場合は、現在のカルチャから書式設定情報が取得されます。

arg0 は、書式設定するオブジェクトを表します。 format の各書式項目は、arg0の文字列形式に置き換えられます。 書式項目に formatString が含まれており、arg0 が IFormattable インターフェイスを実装する場合は、書式設定 arg0.ToString(formatString, provider) 定義します。 それ以外の場合は、arg0.ToString() 書式設定を定義します。

注意 (呼び出し元)

.NET Core および .NET Framework 4.0 以降のバージョンでは、StringBuilder(Int32, Int32) コンストラクターを呼び出して StringBuilder オブジェクトをインスタンス化すると、StringBuilder インスタンスの長さと容量の両方が、MaxCapacity プロパティの値を超えて拡張される可能性があります。 これは、Append(String) メソッドと AppendFormat(String, Object) メソッドを呼び出して小さな文字列を追加する場合に特に発生する可能性があります。

こちらもご覧ください

• .NET の 書式設定の種類
• 複合書式 を する
• 方法: カスタム数値書式プロバイダーを定義して使用する
• 標準の数値書式指定文字列 を する
• カスタム数値書式指定文字列 を する
• 標準の日時書式指定文字列 を する
• カスタム日時書式指定文字列 を する
• 標準の TimeSpan 書式指定文字列 を する
• カスタム TimeSpan 書式指定文字列 を する
• 列挙形式の文字列

AppendFormat(String, Object[])

ソース:

StringBuilder.cs

0 個以上の書式指定項目を含む複合書式指定文字列を処理して返された文字列を、このインスタンスに追加します。 各書式項目は、パラメーター配列内の対応する引数の文字列形式に置き換えられます。

public:
 System::Text::StringBuilder ^ AppendFormat(System::String ^ format, ... cli::array <System::Object ^> ^ args);

public System.Text.StringBuilder AppendFormat (string format, params object?[] args);

member this.AppendFormat : string * obj[] -> System.Text.StringBuilder

Public Function AppendFormat (format As String, ParamArray args As Object()) As StringBuilder

パラメーター

format

String

複合書式指定文字列。

args

Object[]

書式設定するオブジェクトの配列。

戻り値

StringBuilder

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

例外

ArgumentNullException

format または args が null。

FormatException

format が無効です。

-又は-

書式指定項目のインデックスが 0 (ゼロ) 未満であるか、args 配列の長さ以上です。

ArgumentOutOfRangeException

展開された文字列の長さが MaxCapacityを超えています。

例

次の例では、AppendFormat メソッドを示します。

using namespace System;
using namespace System::Text;
using namespace System::Globalization;
void Show( StringBuilder^ sbs )
{
   Console::WriteLine( sbs );
   sbs->Length = 0;
}

int main()
{
   StringBuilder^ sb = gcnew StringBuilder;
   int var1 = 111;
   float var2 = 2.22F;
   String^ var3 = "abcd";
   array<Object^>^var4 = {3,4.4,(Char)'X'};
   Console::WriteLine();
   Console::WriteLine( "StringBuilder.AppendFormat method:" );
   sb->AppendFormat( "1) {0}", var1 );
   Show( sb );
   sb->AppendFormat( "2) {0}, {1}", var1, var2 );
   Show( sb );
   sb->AppendFormat( "3) {0}, {1}, {2}", var1, var2, var3 );
   Show( sb );
   sb->AppendFormat( "4) {0}, {1}, {2}", var4 );
   Show( sb );
   CultureInfo^ ci = gcnew CultureInfo( "es-ES",true );
   array<Object^>^temp1 = {var2};
   sb->AppendFormat( ci, "5) {0}", temp1 );
   Show( sb );
}

/*
This example produces the following results:

StringBuilder.AppendFormat method:
1) 111
2) 111, 2.22
3) 111, 2.22, abcd
4) 3, 4.4, X
5) 2,22
*/

using System;
using System.Text;
using System.Globalization;

class Sample
{
    static StringBuilder sb = new StringBuilder();

    public static void Main()
    {
    int    var1   = 111;
    float  var2   = 2.22F;
    string var3   = "abcd";
    object[] var4 = {3, 4.4, 'X'};

    Console.WriteLine();
    Console.WriteLine("StringBuilder.AppendFormat method:");
    sb.AppendFormat("1) {0}", var1);
    Show(sb);
    sb.AppendFormat("2) {0}, {1}", var1, var2);
    Show(sb);
    sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3);
    Show(sb);
    sb.AppendFormat("4) {0}, {1}, {2}", var4);
    Show(sb);
    CultureInfo ci = new CultureInfo("es-ES", true);
    sb.AppendFormat(ci, "5) {0}", var2);
    Show(sb);
    }

    public static void Show(StringBuilder sbs)
    {
    Console.WriteLine(sbs.ToString());
    sb.Length = 0;
    }
}
/*
This example produces the following results:

StringBuilder.AppendFormat method:
1) 111
2) 111, 2.22
3) 111, 2.22, abcd
4) 3, 4.4, X
5) 2,22
*/

open System.Text
open System.Globalization

let sb = StringBuilder()

let show (sbs: StringBuilder) =
    printfn $"{sbs}"
    sb.Length <- 0

let var1 = 111
let var2 = 2.22f
let var3 = "abcd"
let var4: obj[] = [| 3; 4.4; 'X' |]

printfn "StringBuilder.AppendFormat method:"
sb.AppendFormat("1) {0}", var1) |> ignore
show sb
sb.AppendFormat("2) {0}, {1}", var1, var2) |> ignore
show sb
sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3) |> ignore
show sb
sb.AppendFormat("4) {0}, {1}, {2}", var4) |> ignore
show sb
let ci = CultureInfo("es-ES", true)
sb.AppendFormat(ci, "5) {0}", var2) |> ignore
show sb

// This example produces the following results:
//       StringBuilder.AppendFormat method:
//       1) 111
//       2) 111, 2.22
//       3) 111, 2.22, abcd
//       4) 3, 4.4, X
//       5) 2,22

Imports System.Text
Imports System.Globalization

Class Sample
   Private Shared sb As New StringBuilder()

   Public Shared Sub Main()
      Dim var1 As Integer = 111
      Dim var2 As Single = 2.22F
      Dim var3 As String = "abcd"
      Dim var4 As Object() =  {3, 4.4, "X"c}
      
      Console.WriteLine()
      Console.WriteLine("StringBuilder.AppendFormat method:")
      sb.AppendFormat("1) {0}", var1)
      Show(sb)
      sb.AppendFormat("2) {0}, {1}", var1, var2)
      Show(sb)
      sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3)
      Show(sb)
      sb.AppendFormat("4) {0}, {1}, {2}", var4)
      Show(sb)
      Dim ci As New CultureInfo("es-ES", True)
      sb.AppendFormat(ci, "5) {0}", var2)
      Show(sb)
   End Sub
   
   Public Shared Sub Show(sbs As StringBuilder)
      Console.WriteLine(sbs.ToString())
      sb.Length = 0
   End Sub
End Class
'
'This example produces the following results:
'
'StringBuilder.AppendFormat method:
'1) 111
'2) 111, 2.22
'3) 111, 2.22, abcd
'4) 3, 4.4, X
'5) 2,22

注釈

このメソッドは、.NET Framework の 複合書式設定機能 を使用して、オブジェクトの値をテキスト表現に変換し、その表現を現在の StringBuilder オブジェクトに埋め込みます。

format パラメーターは、このメソッドのパラメーター リスト内のオブジェクトに対応する、0 個以上のインデックス付きプレースホルダー (書式項目と呼ばれます) が混在する 0 個以上のテキスト実行で構成されます。 書式設定プロセスでは、各書式項目が対応するオブジェクトの文字列形式に置き換えられます。

書式項目の構文は次のとおりです。

{index[,length][:formatString]}

角かっこ内の要素は省略可能です。 次の表では、各要素について説明します。

要素	形容
インデックス	書式設定するオブジェクトのパラメーター リスト内の 0 から始まる位置。 インデックス で指定されたオブジェクトが null場合、書式項目は String.Emptyに置き換えられます。 インデックスの 位置にパラメーターがない場合は、FormatException がスローされます。
、長さ	パラメーターの文字列表現の最小文字数。 正の場合、パラメーターは右揃えになります。負の場合は左揃えになります。
:formatString	パラメーターでサポートされる標準書式指定文字列またはカスタム書式指定文字列。

手記

日付と時刻の値で使用される標準書式指定文字列とカスタム書式指定文字列については、「標準の日時書式指定文字列 およびカスタム日時書式指定文字列を参照してください。 数値と共に使用される標準書式指定文字列とカスタム書式指定文字列については、「標準数値書式指定文字列 の と カスタム数値書式指定文字列の」を参照してください。 列挙型で使用される標準書式指定文字列については、「列挙型書式指定文字列 」を参照してください。

args は、書式設定するオブジェクトを表します。 format の各書式項目は、args内の対応するオブジェクトの文字列形式に置き換えられます。 書式項目に formatString が含まれており、args の対応するオブジェクトが IFormattable インターフェイスを実装している場合は、args[index].ToString(formatString, provider) 書式設定が定義されます。 それ以外の場合は、args[index].ToString() 書式設定を定義します。

format に割り当てられた文字列が "{0:####} cans of food to our charitable organization に寄付していただきありがとうございます"、arg0 が値 10 の整数の場合、戻り値は "10 缶の食品を慈善団体に寄付していただきありがとうございます" になります。

注意 (呼び出し元)

.NET Core および .NET Framework 4.0 以降のバージョンでは、StringBuilder(Int32, Int32) コンストラクターを呼び出して StringBuilder オブジェクトをインスタンス化すると、StringBuilder インスタンスの長さと容量の両方が、MaxCapacity プロパティの値を超えて拡張される可能性があります。 これは、Append(String) メソッドと AppendFormat(String, Object) メソッドを呼び出して小さな文字列を追加する場合に特に発生する可能性があります。

こちらもご覧ください

• .NET の 書式設定の種類
• 複合書式 を する
• 標準の数値書式指定文字列 を する
• カスタム数値書式指定文字列 を する
• 標準の日時書式指定文字列 を する
• カスタム日時書式指定文字列 を する
• 標準の TimeSpan 書式指定文字列 を する
• カスタム TimeSpan 書式指定文字列 を する
• 列挙形式の文字列

AppendFormat(String, Object)

ソース:

StringBuilder.cs

0 個以上の書式指定項目を含む複合書式指定文字列を処理して返された文字列を、このインスタンスに追加します。 各書式項目は、1 つの引数の文字列形式に置き換えられます。

public:
 System::Text::StringBuilder ^ AppendFormat(System::String ^ format, System::Object ^ arg0);

public System.Text.StringBuilder AppendFormat (string format, object? arg0);

member this.AppendFormat : string * obj -> System.Text.StringBuilder

Public Function AppendFormat (format As String, arg0 As Object) As StringBuilder

パラメーター

format

String

複合書式指定文字列。

arg0

Object

書式設定するオブジェクト。

戻り値

StringBuilder

format が追加された、このインスタンスへの参照。 format の各書式項目は、arg0の文字列形式に置き換えられます。

例外

ArgumentNullException

format は nullです。

FormatException

format が無効です。

-又は-

書式指定項目のインデックスが 0 (ゼロ) より小さいか、1 以上です。

ArgumentOutOfRangeException

展開された文字列の長さが MaxCapacityを超えています。

例

次の例では、AppendFormat メソッドを示します。

using namespace System;
using namespace System::Text;
using namespace System::Globalization;
void Show( StringBuilder^ sbs )
{
   Console::WriteLine( sbs );
   sbs->Length = 0;
}

int main()
{
   StringBuilder^ sb = gcnew StringBuilder;
   int var1 = 111;
   float var2 = 2.22F;
   String^ var3 = "abcd";
   array<Object^>^var4 = {3,4.4,(Char)'X'};
   Console::WriteLine();
   Console::WriteLine( "StringBuilder.AppendFormat method:" );
   sb->AppendFormat( "1) {0}", var1 );
   Show( sb );
   sb->AppendFormat( "2) {0}, {1}", var1, var2 );
   Show( sb );
   sb->AppendFormat( "3) {0}, {1}, {2}", var1, var2, var3 );
   Show( sb );
   sb->AppendFormat( "4) {0}, {1}, {2}", var4 );
   Show( sb );
   CultureInfo^ ci = gcnew CultureInfo( "es-ES",true );
   array<Object^>^temp1 = {var2};
   sb->AppendFormat( ci, "5) {0}", temp1 );
   Show( sb );
}

/*
This example produces the following results:

StringBuilder.AppendFormat method:
1) 111
2) 111, 2.22
3) 111, 2.22, abcd
4) 3, 4.4, X
5) 2,22
*/

using System;
using System.Text;
using System.Globalization;

class Sample
{
    static StringBuilder sb = new StringBuilder();

    public static void Main()
    {
    int    var1   = 111;
    float  var2   = 2.22F;
    string var3   = "abcd";
    object[] var4 = {3, 4.4, 'X'};

    Console.WriteLine();
    Console.WriteLine("StringBuilder.AppendFormat method:");
    sb.AppendFormat("1) {0}", var1);
    Show(sb);
    sb.AppendFormat("2) {0}, {1}", var1, var2);
    Show(sb);
    sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3);
    Show(sb);
    sb.AppendFormat("4) {0}, {1}, {2}", var4);
    Show(sb);
    CultureInfo ci = new CultureInfo("es-ES", true);
    sb.AppendFormat(ci, "5) {0}", var2);
    Show(sb);
    }

    public static void Show(StringBuilder sbs)
    {
    Console.WriteLine(sbs.ToString());
    sb.Length = 0;
    }
}
/*
This example produces the following results:

StringBuilder.AppendFormat method:
1) 111
2) 111, 2.22
3) 111, 2.22, abcd
4) 3, 4.4, X
5) 2,22
*/

open System.Text
open System.Globalization

let sb = StringBuilder()

let show (sbs: StringBuilder) =
    printfn $"{sbs}"
    sb.Length <- 0

let var1 = 111
let var2 = 2.22f
let var3 = "abcd"
let var4: obj[] = [| 3; 4.4; 'X' |]

printfn "StringBuilder.AppendFormat method:"
sb.AppendFormat("1) {0}", var1) |> ignore
show sb
sb.AppendFormat("2) {0}, {1}", var1, var2) |> ignore
show sb
sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3) |> ignore
show sb
sb.AppendFormat("4) {0}, {1}, {2}", var4) |> ignore
show sb
let ci = CultureInfo("es-ES", true)
sb.AppendFormat(ci, "5) {0}", var2) |> ignore
show sb

// This example produces the following results:
//       StringBuilder.AppendFormat method:
//       1) 111
//       2) 111, 2.22
//       3) 111, 2.22, abcd
//       4) 3, 4.4, X
//       5) 2,22

Imports System.Text
Imports System.Globalization

Class Sample
   Private Shared sb As New StringBuilder()

   Public Shared Sub Main()
      Dim var1 As Integer = 111
      Dim var2 As Single = 2.22F
      Dim var3 As String = "abcd"
      Dim var4 As Object() =  {3, 4.4, "X"c}
      
      Console.WriteLine()
      Console.WriteLine("StringBuilder.AppendFormat method:")
      sb.AppendFormat("1) {0}", var1)
      Show(sb)
      sb.AppendFormat("2) {0}, {1}", var1, var2)
      Show(sb)
      sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3)
      Show(sb)
      sb.AppendFormat("4) {0}, {1}, {2}", var4)
      Show(sb)
      Dim ci As New CultureInfo("es-ES", True)
      sb.AppendFormat(ci, "5) {0}", var2)
      Show(sb)
   End Sub
   
   Public Shared Sub Show(sbs As StringBuilder)
      Console.WriteLine(sbs.ToString())
      sb.Length = 0
   End Sub
End Class
'
'This example produces the following results:
'
'StringBuilder.AppendFormat method:
'1) 111
'2) 111, 2.22
'3) 111, 2.22, abcd
'4) 3, 4.4, X
'5) 2,22

注釈

このメソッドは、.NET Framework の 複合書式設定機能 を使用して、オブジェクトの値をテキスト表現に変換し、その表現を現在の StringBuilder オブジェクトに埋め込みます。

format パラメーターは、0 個以上のテキスト実行と、0 個以上のインデックス付きプレースホルダー (書式項目と呼ばれます) で構成されます。 このメソッドのパラメーター リストの 1 つのオブジェクトである arg0に対応するには、書式項目のインデックスを 0 にする必要があります。 書式設定プロセスでは、各書式項目が arg0の文字列形式に置き換えられます。

書式項目の構文は次のとおりです。

{index[,length][:formatString]}

角かっこ内の要素は省略可能です。 次の表では、各要素について説明します。

要素	形容
インデックス	書式設定するオブジェクトのパラメーター リスト内の 0 から始まる位置。 インデックス で指定されたオブジェクトが null場合、書式項目は String.Emptyに置き換えられます。 インデックスの 位置にパラメーターがない場合は、FormatException がスローされます。
、長さ	パラメーターの文字列表現の最小文字数。 正の場合、パラメーターは右揃えになります。負の場合は左揃えになります。
:formatString	パラメーターでサポートされる標準書式指定文字列またはカスタム書式指定文字列。

手記

日付と時刻の値で使用される標準書式指定文字列とカスタム書式指定文字列については、「標準の日時書式指定文字列 およびカスタム日時書式指定文字列を参照してください。 数値と共に使用される標準書式指定文字列とカスタム書式指定文字列については、「標準数値書式指定文字列 の と カスタム数値書式指定文字列の」を参照してください。 列挙型で使用される標準書式指定文字列については、「列挙型書式指定文字列 」を参照してください。

arg0 は、書式設定するオブジェクトを表します。 format の各書式項目は、arg0の文字列形式に置き換えられます。 書式項目に formatString が含まれており、arg0 が IFormattable インターフェイスを実装する場合は、書式設定 arg0.ToString(formatString, null) 定義します。 それ以外の場合は、arg0.ToString() 書式設定を定義します。

format に割り当てられた文字列が "{0:####} cans of food to our charitable organization に寄付していただきありがとうございます"、arg0 が値 10 の整数の場合、戻り値は "10 缶の食品を慈善団体に寄付していただきありがとうございます" になります。

注意 (呼び出し元)

.NET Core および .NET Framework 4.0 以降のバージョンでは、StringBuilder(Int32, Int32) コンストラクターを呼び出して StringBuilder オブジェクトをインスタンス化すると、StringBuilder インスタンスの長さと容量の両方が、MaxCapacity プロパティの値を超えて拡張される可能性があります。 これは、Append(String) メソッドと AppendFormat(String, Object) メソッドを呼び出して小さな文字列を追加する場合に特に発生する可能性があります。

こちらもご覧ください

• .NET の 書式設定の種類
• 複合書式 を する
• 標準の数値書式指定文字列 を する
• カスタム数値書式指定文字列 を する
• 標準の日時書式指定文字列 を する
• カスタム日時書式指定文字列 を する
• 標準の TimeSpan 書式指定文字列 を する
• カスタム TimeSpan 書式指定文字列 を する
• 列挙形式の文字列

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

ソース:

StringBuilder.cs

0 個以上の書式指定項目を含む複合書式指定文字列を処理して返された文字列を、このインスタンスに追加します。 各書式指定項目は、指定した書式プロバイダーを使用して、任意の引数の文字列形式に置き換えられます。

public:
generic <typename TArg0, typename TArg1, typename TArg2>
 System::Text::StringBuilder ^ AppendFormat(IFormatProvider ^ provider, System::Text::CompositeFormat ^ format, TArg0 arg0, TArg1 arg1, TArg2 arg2);

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

member this.AppendFormat : IFormatProvider * System.Text.CompositeFormat * 'TArg0 * 'TArg1 * 'TArg2 -> System.Text.StringBuilder

Public Function AppendFormat(Of TArg0, TArg1, TArg2) (provider As IFormatProvider, format As CompositeFormat, arg0 As TArg0, arg1 As TArg1, arg2 As TArg2) As StringBuilder

型パラメーター

TArg0

書式設定する最初のオブジェクトの型。

TArg1

書式設定する 2 番目のオブジェクトの型。

TArg2

書式設定する 3 番目のオブジェクトの型。

パラメーター

provider

IFormatProvider

カルチャ固有の書式設定情報を提供するオブジェクト。

format

CompositeFormat

CompositeFormat.

arg0

TArg0

書式設定する最初のオブジェクト。

arg1

TArg1

書式設定する 2 番目のオブジェクト。

arg2

TArg2

書式設定する 3 番目のオブジェクト。

戻り値

StringBuilder

追加操作が完了した後のこのインスタンスへの参照。

例外

ArgumentNullException

format は nullです。

FormatException

書式指定項目のインデックスは、指定された引数の数以上です。

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

ソース:

StringBuilder.cs

0 個以上の書式指定項目を含む複合書式指定文字列を処理して返された文字列を、このインスタンスに追加します。 各書式指定項目は、指定した書式プロバイダーを使用して、任意の引数の文字列形式に置き換えられます。

public:
generic <typename TArg0, typename TArg1>
 System::Text::StringBuilder ^ AppendFormat(IFormatProvider ^ provider, System::Text::CompositeFormat ^ format, TArg0 arg0, TArg1 arg1);

public System.Text.StringBuilder AppendFormat<TArg0,TArg1> (IFormatProvider? provider, System.Text.CompositeFormat format, TArg0 arg0, TArg1 arg1);

member this.AppendFormat : IFormatProvider * System.Text.CompositeFormat * 'TArg0 * 'TArg1 -> System.Text.StringBuilder

Public Function AppendFormat(Of TArg0, TArg1) (provider As IFormatProvider, format As CompositeFormat, arg0 As TArg0, arg1 As TArg1) As StringBuilder

型パラメーター

TArg0

書式設定する最初のオブジェクトの型。

TArg1

書式設定する 2 番目のオブジェクトの型。

パラメーター

provider

IFormatProvider

カルチャ固有の書式設定情報を提供するオブジェクト。

format

CompositeFormat

CompositeFormat.

arg0

TArg0

書式設定する最初のオブジェクト。

arg1

TArg1

書式設定する 2 番目のオブジェクト。

戻り値

StringBuilder

追加操作が完了した後のこのインスタンスへの参照。

例外

ArgumentNullException

format は nullです。

FormatException

書式指定項目のインデックスは、指定された引数の数以上です。

AppendFormat<TArg0>(IFormatProvider, CompositeFormat, TArg0)

ソース:

StringBuilder.cs

0 個以上の書式指定項目を含む複合書式指定文字列を処理して返された文字列を、このインスタンスに追加します。 各書式指定項目は、指定した書式プロバイダーを使用して、任意の引数の文字列形式に置き換えられます。

public:
generic <typename TArg0>
 System::Text::StringBuilder ^ AppendFormat(IFormatProvider ^ provider, System::Text::CompositeFormat ^ format, TArg0 arg0);

public System.Text.StringBuilder AppendFormat<TArg0> (IFormatProvider? provider, System.Text.CompositeFormat format, TArg0 arg0);

member this.AppendFormat : IFormatProvider * System.Text.CompositeFormat * 'TArg0 -> System.Text.StringBuilder

Public Function AppendFormat(Of TArg0) (provider As IFormatProvider, format As CompositeFormat, arg0 As TArg0) As StringBuilder

型パラメーター

TArg0

書式設定する最初のオブジェクトの型。

パラメーター

provider

IFormatProvider

カルチャ固有の書式設定情報を提供するオブジェクト。

format

CompositeFormat

CompositeFormat.

arg0

TArg0

書式設定する最初のオブジェクト。

戻り値

StringBuilder

追加操作が完了した後のこのインスタンスへの参照。

例外

ArgumentNullException

format は nullです。

FormatException

書式指定項目のインデックスは、指定された引数の数以上です。