StringBuilder.AppendFormat メソッド

定義

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

オーバーロード

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

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

AppendFormat(String, Object)

0 個以上の書式項目を含んでいる複合書式指定文字列を処理することで返される文字列を、このインスタンスに追加します。 各書式項目は、単一の引数の文字列表記に置換されます。

AppendFormat(String, Object[])

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

AppendFormat(IFormatProvider, String, Object)

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

AppendFormat(IFormatProvider, String, Object[])

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

AppendFormat(String, Object, Object)

0 個以上の書式項目を含んでいる複合書式指定文字列を処理することで返される文字列を、このインスタンスに追加します。 各書式項目は、2 つの引数のどちらかの文字列形式に置換されます。

AppendFormat(IFormatProvider, String, Object, Object)

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

AppendFormat(String, Object, Object, Object)

0 個以上の書式項目を含んでいる複合書式指定文字列を処理することで返される文字列を、このインスタンスに追加します。 各書式項目は、3 つの引数のいずれかの文字列形式に置換されます。

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

0 個以上の書式項目を含んでいる複合書式指定文字列を処理することで返される文字列を、このインスタンスに追加します。 各書式項目は、指定された書式プロバイダーを使用して 3 つの引数のいずれかの文字列形式に置換されます。各書式項目は、指定された書式プロバイダーを使用して 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);
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

1 番目に書式設定するオブジェクト。

arg1
Object

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

arg2
Object

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

戻り値

StringBuilder

追加操作が完了した後のこのインスタンスへの参照。追加操作が完了した後のこのインスタンスへの参照。 追加操作の完了後、このインスタンスには、操作前に存在していたデータの末尾に format のコピーが付加されたものが含まれます。このコピーでは、書式指定が、対応するオブジェクト引数の文字列形式に置換されています。

例外

formatnullです。

format が無効です。

  • または -

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

拡張された文字列の長さが MaxCapacity を超えます。

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

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)
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 します。

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

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

{index[,length][:formatString]}

角かっこ内の要素は省略可能です。 次の表は、それぞれの要素の説明です。

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

注意

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

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

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

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

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

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

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

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

注意 (呼び出し元)

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

こちらもご覧ください

適用対象

AppendFormat(String, Object)

0 個以上の書式項目を含んでいる複合書式指定文字列を処理することで返される文字列を、このインスタンスに追加します。 各書式項目は、単一の引数の文字列表記に置換されます。

public:
 System::Text::StringBuilder ^ AppendFormat(System::String ^ format, System::Object ^ arg0);
public System.Text.StringBuilder AppendFormat (string format, 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 の文字列表記に置換されます。

例外

formatnullです。

format が無効です。

  • または -

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

拡張された文字列の長さが 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
*/
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個以上のテキストの実行で構成されます。 書式項目のインデックスは、 arg0 このメソッドのパラメーターリスト内の単一のオブジェクトに対応する0にする必要があります。 書式設定のプロセスでは、各書式項目がの文字列形式に置き換えら arg0 れます。

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

{index[,length] [:formatString]}

角かっこ内の要素は省略可能です。 次の表は、それぞれの要素の説明です。

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

注意

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

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

に割り当てられている文字列 format が "{0: # # # #} 食品の寄贈組織に感謝しています。" また、値が10の整数である場合、 arg0 戻り値は "私たちの慈善組織に対する食料の10人の寄付に感謝しています" という結果になります。

注意 (呼び出し元)

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

こちらもご覧ください

適用対象

AppendFormat(String, Object[])

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

public:
 System::Text::StringBuilder ^ AppendFormat(System::String ^ format, ... cli::array <System::Object ^> ^ args);
public System.Text.StringBuilder AppendFormat (string format, params 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 の各書式項目は、対応するオブジェクト引数の文字列形式に置換されます。

例外

format または argsnull です。

format が無効です。

  • または -

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

拡張された文字列の長さが 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
*/
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から始まる位置。 Index で指定されたオブジェクトがの場合 null 、書式項目はによって置き換えられ String.Empty ます。 インデックス 位置にパラメーターがない場合は、 FormatException がスローされます。
長さ パラメーターの文字列形式の最小文字数。 正の場合、パラメーターは右上にあります。負の場合は、左揃えになります。
:formatString パラメーターでサポートされている標準またはカスタムの書式指定文字列。

注意

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

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

に割り当てられた文字列が format ":##### } cans of food cans to our charitable organization." ({0:####} cans of food cans to our charitable organization に感謝します)" である場合。 と は 10 の値を持つ整数です。戻り値は "10 cans of food to our arg0 charitable organization に感謝します" になります。

注意 (呼び出し元)

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

こちらもご覧ください

適用対象

AppendFormat(IFormatProvider, String, Object)

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

public:
 System::Text::StringBuilder ^ AppendFormat(IFormatProvider ^ provider, System::String ^ format, System::Object ^ arg0);
public System.Text.StringBuilder AppendFormat (IFormatProvider provider, string format, 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

追加操作が完了した後のこのインスタンスへの参照。追加操作が完了した後のこのインスタンスへの参照。 追加操作の完了後、このインスタンスには、操作前に存在していたデータの末尾に format のコピーが付加されたものが含まれます。このコピーでは、書式指定が、arg0 の文字列形式に置換されています。

例外

formatnullです。

format が無効です。

  • または -

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

拡張された文字列の長さが MaxCapacity を超えます。

メソッドの 2 つの呼び出しを次に AppendFormat(IFormatProvider, String, Object) 示します。 どちらも、英国 (en-GB) English-Great形式規則を使用します。 最初のは、値の通貨の文字列 Decimal 形式を結果文字列に挿入します。 2 番目の値は、結果文字列の 2 つの場所に挿入されます。1 つ目は短い日付文字列のみを含み、2 つ目は短 DateTime い時刻文字列です。

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
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 む方法です。

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

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

{index[,length][:formatString]}

角かっこ内の要素は省略可能です。 次の表は、それぞれの要素の説明です。

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

注意

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

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

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

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

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

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

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

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

注意 (呼び出し元)

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

こちらもご覧ください

適用対象

AppendFormat(IFormatProvider, String, Object[])

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);
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 のコピーが付加されたものが含まれます。このコピーでは、書式指定が、対応するオブジェクト引数の文字列形式に置換されています。

例外

formatnullです。

format が無効です。

  • または -

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

拡張された文字列の長さが 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
*/
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

次の例では、 IFormatProvider という名前のカスタム実装を定義しています。この実装では、 CustomerFormatter 4 桁の顧客番号と、4番目と7番目の数字の後にハイフンを付けます これは、 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
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 します。

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

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

{index[,length][:formatString]}

角かっこ内の要素は省略可能です。 次の表は、それぞれの要素の説明です。

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

注意

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

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

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

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

注意 (呼び出し元)

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

こちらもご覧ください

適用対象

AppendFormat(String, Object, Object)

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);
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

1 番目に書式設定するオブジェクト。

arg1
Object

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

戻り値

StringBuilder

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

例外

formatnullです。

format が無効です。

  • または -

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

拡張された文字列の長さが 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
*/
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 ます。

このパラメーターは、0個以上 format のテキストの組み合わせで構成されます。書式指定項目とは、 arg0 arg1 このメソッドのパラメーターリストに含まれる2つのオブジェクトのうち、およびに対応する、0個以上のインデックス付きプレースホルダーが混在したものです。 書式設定のプロセスでは、各書式項目が対応するオブジェクトの文字列形式に置き換えられます。

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

{index[,length] [:formatString]}

角かっこ内の要素は省略可能です。 次の表は、それぞれの要素の説明です。

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

注意

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

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

に割り当てられている文字列 format が "{0: # # # #} 食品の寄贈組織に感謝しています。" また、値が10の整数である場合、 arg0 戻り値は "私たちの慈善組織に対する食料の10人の寄付に感謝しています" という結果になります。

注意 (呼び出し元)

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

こちらもご覧ください

適用対象

AppendFormat(IFormatProvider, String, Object, Object)

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);
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

1 番目に書式設定するオブジェクト。

arg1
Object

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

戻り値

StringBuilder

追加操作が完了した後のこのインスタンスへの参照。追加操作が完了した後のこのインスタンスへの参照。 追加操作の完了後、このインスタンスには、操作前に存在していたデータの末尾に format のコピーが付加されたものが含まれます。このコピーでは、書式指定が、対応するオブジェクト引数の文字列形式に置換されています。

例外

formatnullです。

format が無効です。

  • または -

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

拡張された文字列の長さが MaxCapacity を超えます。

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

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

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

{index[,length][:formatString]}

角かっこ内の要素は省略可能です。 次の表は、それぞれの要素の説明です。

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

注意

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

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

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

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

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

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

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

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

注意 (呼び出し元)

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

こちらもご覧ください

適用対象

AppendFormat(String, Object, Object, Object)

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);
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

1 番目に書式設定するオブジェクト。

arg1
Object

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

arg2
Object

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

戻り値

StringBuilder

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

例外

formatnullです。

format が無効です。

  • または -

書式項目のインデックスが 0 (ゼロ) 未満か、または 3 以上です。

拡張された文字列の長さが 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
*/
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 個以上のインデックス付きプレースホルダー (書式項目と呼ばれる) が混在し、このメソッドのパラメーター リスト内の オブジェクトに対応します。 arg0 arg2 書式設定プロセスでは、各書式項目を対応する オブジェクトの文字列形式に置き換える。

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

{index[,length][:formatString]}

角かっこ内の要素は省略可能です。 次の表は、それぞれの要素の説明です。

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

注意

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

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

に割り当てられた文字列が format ":##### } cans of food cans to our charitable organization." ({0:####} cans of food cans to our charitable organization に感謝します)" である場合。 と は 10 の値を持つ整数です。戻り値は "10 cans of food to our arg0 charitable organization に感謝します" になります。

注意 (呼び出し元)

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

こちらもご覧ください

適用対象