StringBuilder.AppendFormat メソッド

定義

0 個以上の書式項目を含んでいる複合書式指定文字列を処理することで返される文字列を、このインスタンスに追加します。Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. 各書式項目は、対応するオブジェクト引数の文字列形式に置換されます。Each format item is replaced by the string representation of a corresponding object argument.

オーバーロード

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

0 個以上の書式項目を含んでいる複合書式指定文字列を処理することで返される文字列を、このインスタンスに追加します。Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. 各書式項目は、指定された書式プロバイダーを使用して 3 つの引数のいずれかの文字列形式に置換されます。各書式項目は、指定された書式プロバイダーを使用して 3 つの引数のいずれかの文字列形式に置換されます。Each format item is replaced by the string representation of either of three arguments using a specified format provider.

AppendFormat(String, Object)

0 個以上の書式項目を含んでいる複合書式指定文字列を処理することで返される文字列を、このインスタンスに追加します。Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. 各書式項目は、単一の引数の文字列表記に置換されます。Each format item is replaced by the string representation of a single argument.

AppendFormat(String, Object[])

0 個以上の書式項目を含んでいる複合書式指定文字列を処理することで返される文字列を、このインスタンスに追加します。Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. 各書式項目は、パラメーター配列内の対応する引数の文字列形式に置換されます。Each format item is replaced by the string representation of a corresponding argument in a parameter array.

AppendFormat(IFormatProvider, String, Object)

0 個以上の書式項目を含んでいる複合書式指定文字列を処理することで返される文字列を、このインスタンスに追加します。Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. 各書式指定項目は、指定された書式プロバイダーを使用して単一の引数の文字列形式に置換されます。Each format item is replaced by the string representation of a single argument using a specified format provider.

AppendFormat(IFormatProvider, String, Object[])

0 個以上の書式項目を含んでいる複合書式指定文字列を処理することで返される文字列を、このインスタンスに追加します。Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. 各書式項目は、指定された書式プロバイダーを使用した、パラメーター配列内の対応する引数の文字列形式に置換されます。Each format item is replaced by the string representation of a corresponding argument in a parameter array using a specified format provider.

AppendFormat(String, Object, Object)

0 個以上の書式項目を含んでいる複合書式指定文字列を処理することで返される文字列を、このインスタンスに追加します。Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. 各書式項目は、2 つの引数のどちらかの文字列形式に置換されます。Each format item is replaced by the string representation of either of two arguments.

AppendFormat(IFormatProvider, String, Object, Object)

0 個以上の書式項目を含んでいる複合書式指定文字列を処理することで返される文字列を、このインスタンスに追加します。Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. 各書式項目は、指定された書式プロバイダーを使用して 2 つの引数のいずれかの文字列形式に置換されます。Each format item is replaced by the string representation of either of two arguments using a specified format provider.

AppendFormat(String, Object, Object, Object)

0 個以上の書式項目を含んでいる複合書式指定文字列を処理することで返される文字列を、このインスタンスに追加します。Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. 各書式項目は、3 つの引数のいずれかの文字列形式に置換されます。Each format item is replaced by the string representation of either of three arguments.

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

0 個以上の書式項目を含んでいる複合書式指定文字列を処理することで返される文字列を、このインスタンスに追加します。Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. 各書式項目は、指定された書式プロバイダーを使用して 3 つの引数のいずれかの文字列形式に置換されます。各書式項目は、指定された書式プロバイダーを使用して 3 つの引数のいずれかの文字列形式に置換されます。Each format item is replaced by the string representation of either of three arguments using a specified format provider.

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

カルチャ固有の書式情報を提供するオブジェクト。An object that supplies culture-specific formatting information.

format
String

複合書式設定文字列。A composite format string.

arg0
Object

1 番目に書式設定するオブジェクト。The first object to format.

arg1
Object

2 番目に書式設定するオブジェクト。The second object to format.

arg2
Object

3 番目に書式設定するオブジェクト。3 番目に書式設定するオブジェクト。The third object to format.

戻り値

追加操作が完了した後のこのインスタンスへの参照。追加操作が完了した後のこのインスタンスへの参照。A reference to this instance after the append operation has completed. 追加操作の完了後、このインスタンスには、操作前に存在していたデータの末尾に format のコピーが付加されたものが含まれます。このコピーでは、書式指定が、対応するオブジェクト引数の文字列形式に置換されています。After the append operation, this instance contains any data that existed before the operation, suffixed by a copy of format where any format specification is replaced by the string representation of the corresponding object argument.

例外

formatnullです。format is null.

format が無効です。format is invalid.

- または --or-

書式項目のインデックスが 0 (ゼロ) 未満か、3 以上です。The index of a format item is less than 0 (zero), or greater than or equal to 3 (three).

拡張された文字列の長さが MaxCapacity を超えます。The length of the expanded string would exceed MaxCapacity.

次の例では、AppendFormat(IFormatProvider, String, Object, Object, Object) メソッドを使用して、整数値を持つブール And 演算の結果を示します。The following example uses the AppendFormat(IFormatProvider, String, Object, Object, Object) method to illustrate the result of a Boolean And operation with integer values. 書式指定文字列には6つの書式項目が含まれていますが、各項目は2つの異なる方法で書式設定されるため、メソッドの引数リストには3つの項目しかありません。Note that the format string includes six format items, but the method has only three items in its argument list, because each item is formatted in two different ways.

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 オブジェクトに埋め込みます。This method uses the composite formatting feature of the .NET Framework to convert the value of an object to its text representation and embed that representation in the current StringBuilder object.

format パラメーターは、このメソッドのパラメーターリスト内のオブジェクトに対応する0個以上のインデックス付きプレースホルダー (書式項目と呼ばれます) と共に、0個以上のテキストの実行で構成されます。The format parameter consists of zero or more runs of text intermixed with zero or more indexed placeholders, called format items, that correspond to objects in the parameter list of this method. 書式設定のプロセスでは、各書式項目が対応するオブジェクトの文字列形式に置き換えられます。The formatting process replaces each format item with the string representation of the corresponding object.

書式指定項目の構文は次のとおりです。The syntax of a format item is as follows:

{index[,length][:formatString]}{index[,length][:formatString]}

角かっこ内の要素は省略可能です。Elements in square brackets are optional. 次の表は、それぞれの要素の説明です。The following table describes each element.

要素Element 説明Description
indexindex 書式設定するオブジェクトのパラメーターリスト内の0から始まる位置。The zero-based position in the parameter list of the object to be formatted. Indexで指定されたオブジェクトが null場合、書式項目は String.Emptyに置き換えられます。If the object specified by index is null, the format item is replaced by String.Empty. インデックス位置にパラメーターがない場合は、FormatException がスローされます。If there is no parameter in the index position, a FormatException is thrown.
length,length パラメーターの文字列形式の最小文字数。The minimum number of characters in the string representation of the parameter. 正の場合、パラメーターは右上にあります。負の場合は、左揃えになります。If positive, the parameter is right-aligned; if negative, it is left-aligned.
:formatString:formatString パラメーターでサポートされている標準またはカスタムの書式指定文字列。A standard or custom format string that is supported by the parameter.

注意

日付と時刻の値と共に使用される標準およびカスタム書式指定文字列については、「標準の日付と時刻の書式指定文字列」および「カスタム日時書式指定文字列」を参照してください。For the standard and custom format strings used with date and time values, see Standard Date and Time Format Strings and Custom Date and Time Format Strings. 数値で使用される標準およびカスタム書式指定文字列については、「標準の数値書式指定文字列」および「カスタム数値書式指定文字列」を参照してください。For the standard and custom format strings used with numeric values, see Standard Numeric Format Strings and Custom Numeric Format Strings. 列挙体で使用される標準書式指定文字列については、「列挙型書式指定文字列」を参照してください。For the standard format strings used with enumerations, see Enumeration Format Strings.

provider パラメーターは、arg0arg1の書式設定情報を提供できる IFormatProvider の実装を指定します。The provider parameter specifies an IFormatProvider implementation that can provide formatting information for arg0 and arg1. provider は、次のいずれかになります。provider can be any of the following:

  • カルチャ固有の書式情報を提供する CultureInfo オブジェクト。A CultureInfo object that provides culture-specific formatting information.

  • 数値の場合、arg0 または arg1 にカルチャ固有の書式情報を提供する NumberFormatInfo オブジェクト。A NumberFormatInfo object that provides culture-specific formatting information for arg0 or arg1 if they are numeric values.

  • arg0arg1、または arg2 の日付と時刻の値である場合に、カルチャ固有の書式情報を提供する DateTimeFormatInfo オブジェクト。A DateTimeFormatInfo object that provides culture-specific formatting information for arg0, arg1, or arg2 if they are date and time values.

  • arg0arg1、および arg2の書式設定情報を提供するカスタム IFormatProvider 実装。A custom IFormatProvider implementation that provides formatting information for arg0, arg1, and arg2. 通常、このような実装では、ICustomFormatter インターフェイスも実装します。Typically, such an implementation also implements the ICustomFormatter interface.

provider パラメーターが nullの場合、書式プロバイダー情報は現在のカルチャから取得されます。If the provider parameter is null, format provider information is obtained from the current culture.

arg0arg1、および arg2 は、書式設定するオブジェクトを表します。arg0, arg1, and arg2 represent the objects to be formatted. format 内の各書式指定項目は、対応するインデックスを持つオブジェクトの文字列形式に置き換えられます。Each format item in format is replaced with the string representation of the object that has the corresponding index. 書式指定項目に formatString が含まれていて、対応する引数が IFormattable インターフェイスを実装している場合は、引数の ToString(formatString, provider) メソッドによって書式設定が定義されます。If the format item includes formatString and the corresponding argument implements the IFormattable interface, then the argument's ToString(formatString, provider) method defines the formatting. それ以外の場合は、引数の ToString() メソッドによって書式設定が定義されます。Otherwise, the argument's ToString() method defines the formatting.

注意 (呼び出し元)

.NET Core および .NET Framework 4.0 以降のバージョンでは、StringBuilder(Int32, Int32) コンストラクターを呼び出すことによって StringBuilder オブジェクトをインスタンス化すると、StringBuilder インスタンスの長さと容量の両方が、その MaxCapacity プロパティの値を超えて拡張される可能性があります。In .NET Core and in the .NET Framework 4.0 and later versions, when you instantiate the StringBuilder object by calling the StringBuilder(Int32, Int32) constructor, both the length and the capacity of the StringBuilder instance can grow beyond the value of its MaxCapacity property. これは、Append(String)AppendFormat(String, Object) メソッドを呼び出して小さい文字列を追加する場合に特に発生します。This can occur particularly when you call the Append(String) and AppendFormat(String, Object) methods to append small strings.

こちらもご覧ください

AppendFormat(String, Object)

0 個以上の書式項目を含んでいる複合書式指定文字列を処理することで返される文字列を、このインスタンスに追加します。Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. 各書式項目は、単一の引数の文字列表記に置換されます。Each format item is replaced by the string representation of a single argument.

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

複合書式設定文字列。A composite format string.

arg0
Object

書式指定するオブジェクト。An object to format.

戻り値

format が追加されたこのインスタンスへの参照。A reference to this instance with format appended. format の各書式指定項目は、arg0 の文字列表記に置換されます。Each format item in format is replaced by the string representation of arg0.

例外

formatnullです。format is null.

format が無効です。format is invalid.

- または --or-

書式項目のインデックスが 0 (ゼロ) 未満か、1 以上です。The index of a format item is less than 0 (zero), or greater than or equal to 1.

拡張された文字列の長さが MaxCapacity を超えます。The length of the expanded string would exceed MaxCapacity.

AppendFormatメソッドの例を次に示します。The following example demonstrates the AppendFormat method.

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 オブジェクトに埋め込みます。This method uses the composite formatting feature of the .NET Framework to convert the value of an object to its text representation and embed that representation in the current StringBuilder object.

format パラメーターは、書式指定項目と呼ばれる0個以上のインデックス付きプレースホルダーと共に、0個以上のテキストの実行で構成されます。The format parameter consists of zero or more runs of text intermixed with zero or more indexed placeholders, called format items. 書式項目のインデックスは、このメソッドのパラメーターリスト内の1つのオブジェクト arg0に対応する0にする必要があります。The index of the format items must be 0, to correspond to arg0, the single object in the parameter list of this method. 書式設定のプロセスでは、各書式項目が arg0の文字列形式に置き換えられます。The formatting process replaces each format item with the string representation of arg0.

書式指定項目の構文は次のとおりです。The syntax of a format item is as follows:

{index[,length][:formatString]}{index[,length][:formatString]}

角かっこ内の要素は省略可能です。Elements in square brackets are optional. 次の表は、それぞれの要素の説明です。The following table describes each element.

要素Element 説明Description
indexindex 書式設定するオブジェクトのパラメーターリスト内の0から始まる位置。The zero-based position in the parameter list of the object to be formatted. Indexで指定されたオブジェクトが null場合、書式項目は String.Emptyに置き換えられます。If the object specified by index is null, the format item is replaced by String.Empty. インデックス位置にパラメーターがない場合は、FormatException がスローされます。If there is no parameter in the index position, a FormatException is thrown.
length,length パラメーターの文字列形式の最小文字数。The minimum number of characters in the string representation of the parameter. 正の場合、パラメーターは右上にあります。負の場合は、左揃えになります。If positive, the parameter is right-aligned; if negative, it is left-aligned.
:formatString:formatString パラメーターでサポートされている標準またはカスタムの書式指定文字列。A standard or custom format string that is supported by the parameter.

注意

日付と時刻の値と共に使用される標準およびカスタム書式指定文字列については、「標準の日付と時刻の書式指定文字列」および「カスタム日時書式指定文字列」を参照してください。For the standard and custom format strings used with date and time values, see Standard Date and Time Format Strings and Custom Date and Time Format Strings. 数値で使用される標準およびカスタム書式指定文字列については、「標準の数値書式指定文字列」および「カスタム数値書式指定文字列」を参照してください。For the standard and custom format strings used with numeric values, see Standard Numeric Format Strings and Custom Numeric Format Strings. 列挙体で使用される標準書式指定文字列については、「列挙型書式指定文字列」を参照してください。For the standard format strings used with enumerations, see Enumeration Format Strings.

arg0 は、書式設定するオブジェクトを表します。arg0 represents the object to be formatted. format 内の各書式指定項目は、arg0の文字列形式に置き換えられます。Each format item in format is replaced with the string representation of arg0. 書式指定項目に formatString が含まれており、arg0 IFormattable インターフェイスが実装されている場合、arg0.ToString(formatString, null) は書式設定を定義します。If the format item includes formatString and arg0 implements the IFormattable interface, then arg0.ToString(formatString, null) defines the formatting. それ以外の場合は、arg0.ToString() によって書式設定が定義されます。Otherwise, arg0.ToString() defines the formatting.

format に割り当てられた文字列が "{0: # # # #} の食料を慈善団体に寄付しようとしています" という内容の場合は、If the string assigned to format is "Thank you for your donation of {0:####} cans of food to our charitable organization." また arg0 は値が10の整数です。この戻り値は、"私たちの慈善団体に対して10人の食べ物を寄付したとしていただき、ありがとうございました" となります。and arg0 is an integer with the value 10, the return value will be "Thank you for your donation of 10 cans of food to our charitable organization."

注意 (呼び出し元)

.NET Core および .NET Framework 4.0 以降のバージョンでは、StringBuilder(Int32, Int32) コンストラクターを呼び出すことによって StringBuilder オブジェクトをインスタンス化すると、StringBuilder インスタンスの長さと容量の両方が、その MaxCapacity プロパティの値を超えて拡張される可能性があります。In .NET Core and in the .NET Framework 4.0 and later versions, when you instantiate the StringBuilder object by calling the StringBuilder(Int32, Int32) constructor, both the length and the capacity of the StringBuilder instance can grow beyond the value of its MaxCapacity property. これは、Append(String)AppendFormat(String, Object) メソッドを呼び出して小さい文字列を追加する場合に特に発生します。This can occur particularly when you call the Append(String) and AppendFormat(String, Object) methods to append small strings.

こちらもご覧ください

AppendFormat(String, Object[])

0 個以上の書式項目を含んでいる複合書式指定文字列を処理することで返される文字列を、このインスタンスに追加します。Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. 各書式項目は、パラメーター配列内の対応する引数の文字列形式に置換されます。Each format item is replaced by the string representation of a corresponding argument in a parameter array.

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

複合書式設定文字列。A composite format string.

args
Object[]

書式指定するオブジェクトの配列。An array of objects to format.

戻り値

format が追加されたこのインスタンスへの参照。A reference to this instance with format appended. format の各書式項目は、対応するオブジェクト引数の文字列形式に置換されます。Each format item in format is replaced by the string representation of the corresponding object argument.

例外

format または argsnull です。format or args is null.

format が無効です。format is invalid.

- または --or-

書式項目のインデックスが 0 (ゼロ) 未満であるか、args 配列の長さ以上です。The index of a format item is less than 0 (zero), or greater than or equal to the length of the args array.

拡張された文字列の長さが MaxCapacity を超えます。The length of the expanded string would exceed MaxCapacity.

AppendFormatメソッドの例を次に示します。The following example demonstrates the AppendFormat method.

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 オブジェクトに埋め込みます。This method uses the composite formatting feature of the .NET Framework to convert the value of an object to its text representation and embed that representation in the current StringBuilder object.

format パラメーターは、このメソッドのパラメーターリスト内のオブジェクトに対応する0個以上のインデックス付きプレースホルダー (書式項目と呼ばれます) と共に、0個以上のテキストの実行で構成されます。The format parameter consists of zero or more runs of text intermixed with zero or more indexed placeholders, called format items, that correspond to objects in the parameter list of this method. 書式設定のプロセスでは、各書式項目が対応するオブジェクトの文字列形式に置き換えられます。The formatting process replaces each format item with the string representation of the corresponding object.

書式指定項目の構文は次のとおりです。The syntax of a format item is as follows:

{index[,length][:formatString]}{index[,length][:formatString]}

角かっこ内の要素は省略可能です。Elements in square brackets are optional. 次の表は、それぞれの要素の説明です。The following table describes each element.

要素Element 説明Description
indexindex 書式設定するオブジェクトのパラメーターリスト内の0から始まる位置。The zero-based position in the parameter list of the object to be formatted. Indexで指定されたオブジェクトが null場合、書式項目は String.Emptyに置き換えられます。If the object specified by index is null, the format item is replaced by String.Empty. インデックス位置にパラメーターがない場合は、FormatException がスローされます。If there is no parameter in the index position, a FormatException is thrown.
length,length パラメーターの文字列形式の最小文字数。The minimum number of characters in the string representation of the parameter. 正の場合、パラメーターは右上にあります。負の場合は、左揃えになります。If positive, the parameter is right-aligned; if negative, it is left-aligned.
:formatString:formatString パラメーターでサポートされている標準またはカスタムの書式指定文字列。A standard or custom format string that is supported by the parameter.

注意

日付と時刻の値と共に使用される標準およびカスタム書式指定文字列については、「標準の日付と時刻の書式指定文字列」および「カスタム日時書式指定文字列」を参照してください。For the standard and custom format strings used with date and time values, see Standard Date and Time Format Strings and Custom Date and Time Format Strings. 数値で使用される標準およびカスタム書式指定文字列については、「標準の数値書式指定文字列」および「カスタム数値書式指定文字列」を参照してください。For the standard and custom format strings used with numeric values, see Standard Numeric Format Strings and Custom Numeric Format Strings. 列挙体で使用される標準書式指定文字列については、「列挙型書式指定文字列」を参照してください。For the standard format strings used with enumerations, see Enumeration Format Strings.

args は、書式設定するオブジェクトを表します。args represents the objects to be formatted. format 内の各書式指定項目は、args内の対応するオブジェクトの文字列形式に置き換えられます。Each format item in format is replaced with the string representation of the corresponding object in args. 書式指定項目に formatString が含まれており、args 内の対応するオブジェクトが IFormattable インターフェイスを実装している場合、args[index].ToString(formatString, provider) は書式設定を定義します。If the format item includes formatString and the corresponding object in args implements the IFormattable interface, then args[index].ToString(formatString, provider) defines the formatting. それ以外の場合は、args[index].ToString() によって書式設定が定義されます。Otherwise, args[index].ToString() defines the formatting.

format に割り当てられた文字列が "{0: # # # #} の食料を慈善団体に寄付しようとしています" という内容の場合は、If the string assigned to format is "Thank you for your donation of {0:####} cans of food to our charitable organization." また arg0 は値が10の整数です。この戻り値は、"私たちの慈善団体に対して10人の食べ物を寄付したとしていただき、ありがとうございました" となります。and arg0 is an integer with the value 10, the return value will be "Thank you for your donation of 10 cans of food to our charitable organization."

注意 (呼び出し元)

.NET Core および .NET Framework 4.0 以降のバージョンでは、StringBuilder(Int32, Int32) コンストラクターを呼び出すことによって StringBuilder オブジェクトをインスタンス化すると、StringBuilder インスタンスの長さと容量の両方が、その MaxCapacity プロパティの値を超えて拡張される可能性があります。In .NET Core and in the .NET Framework 4.0 and later versions, when you instantiate the StringBuilder object by calling the StringBuilder(Int32, Int32) constructor, both the length and the capacity of the StringBuilder instance can grow beyond the value of its MaxCapacity property. これは、Append(String)AppendFormat(String, Object) メソッドを呼び出して小さい文字列を追加する場合に特に発生します。This can occur particularly when you call the Append(String) and AppendFormat(String, Object) methods to append small strings.

こちらもご覧ください

AppendFormat(IFormatProvider, String, Object)

0 個以上の書式項目を含んでいる複合書式指定文字列を処理することで返される文字列を、このインスタンスに追加します。Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. 各書式指定項目は、指定された書式プロバイダーを使用して単一の引数の文字列形式に置換されます。Each format item is replaced by the string representation of a single argument using a specified format provider.

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

カルチャ固有の書式情報を提供するオブジェクト。An object that supplies culture-specific formatting information.

format
String

複合書式設定文字列。A composite format string.

arg0
Object

書式指定するオブジェクト。The object to format.

戻り値

追加操作が完了した後のこのインスタンスへの参照。追加操作が完了した後のこのインスタンスへの参照。A reference to this instance after the append operation has completed. 追加操作の完了後、このインスタンスには、操作前に存在していたデータの末尾に format のコピーが付加されたものが含まれます。このコピーでは、書式指定が、arg0 の文字列形式に置換されています。After the append operation, this instance contains any data that existed before the operation, suffixed by a copy of format in which any format specification is replaced by the string representation of arg0.

例外

formatnullです。format is null.

format が無効です。format is invalid.

- または --or-

書式項目のインデックスが 0 (ゼロ) より小さいか、または 1 以上です。The index of a format item is less than 0 (zero), or greater than or equal to one (1).

拡張された文字列の長さが MaxCapacity を超えます。The length of the expanded string would exceed MaxCapacity.

AppendFormat(IFormatProvider, String, Object) メソッドの2つの呼び出しを次に示します。The following includes two calls to the AppendFormat(IFormatProvider, String, Object) method. どちらも、英語版の英国 (en-us) カルチャの書式指定規則を使用します。Both use the formatting conventions of the English-Great Britain (en-GB) culture. 最初のは、Decimal 値の通貨の文字列形式を結果の文字列に挿入します。The first inserts the string representation of a Decimal value currency in a result string. 2番目の方法では、結果文字列の2つの場所に DateTime 値が挿入されます。最初の位置には短い日付文字列と短い時刻文字列のみが含まれます。The second inserts a DateTime value in two places in a result string, the first including only the short date string and the second the short time string.

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 オブジェクトに埋め込みます。This method uses the composite formatting feature of the .NET Framework to convert the value of arg0 to its text representation and embed that representation in the current StringBuilder object.

format パラメーターは、書式指定項目と呼ばれる0個以上のインデックス付きプレースホルダーと共に、0個以上のテキストの実行で構成されます。The format parameter consists of zero or more runs of text intermixed with zero or more indexed placeholders, called format items. 各書式指定項目のインデックスはゼロ (0) である必要があります。このメソッドには1つの引数を持つ引数リストが含まれているためです。The index of each format item must be zero (0) since this method includes an argument list with a single argument. 書式設定のプロセスでは、各書式項目が arg0の文字列形式に置き換えられます。The formatting process replaces each format item with the string representation of arg0.

書式指定項目の構文は次のとおりです。The syntax of a format item is as follows:

{index[,length][:formatString]}{index[,length][:formatString]}

角かっこ内の要素は省略可能です。Elements in square brackets are optional. 次の表は、それぞれの要素の説明です。The following table describes each element.

要素Element 説明Description
indexindex 書式設定するオブジェクトのパラメーターリスト内の0から始まる位置。The zero-based position in the parameter list of the object to be formatted. Indexで指定されたオブジェクトが null場合、書式項目は String.Emptyに置き換えられます。If the object specified by index is null, the format item is replaced by String.Empty. この場合、AppendFormat(IFormatProvider, String, Object) メソッドの引数リストには1つの引数があるため、 indexの値は常に0である必要があります。In this case, since the AppendFormat(IFormatProvider, String, Object) method has a single argument in the argument list, the value of index must always be 0. そうでない場合は、FormatException がスローされます。If it is not, a FormatException is thrown.
length,length パラメーターの文字列形式の最小文字数。The minimum number of characters in the string representation of the parameter. 正の場合、パラメーターは右上にあります。負の場合は、左揃えになります。If positive, the parameter is right-aligned; if negative, it is left-aligned.
:formatString:formatString パラメーターでサポートされている標準またはカスタムの書式指定文字列。A standard or custom format string that is supported by the parameter.

注意

日付と時刻の値と共に使用される標準およびカスタム書式指定文字列については、「標準の日付と時刻の書式指定文字列」および「カスタム日時書式指定文字列」を参照してください。For the standard and custom format strings used with date and time values, see Standard Date and Time Format Strings and Custom Date and Time Format Strings. 数値で使用される標準およびカスタム書式指定文字列については、「標準の数値書式指定文字列」および「カスタム数値書式指定文字列」を参照してください。For the standard and custom format strings used with numeric values, see Standard Numeric Format Strings and Custom Numeric Format Strings. 列挙体で使用される標準書式指定文字列については、「列挙型書式指定文字列」を参照してください。For the standard format strings used with enumerations, see Enumeration Format Strings.

provider パラメーターは args内のオブジェクトの書式設定情報を提供できる IFormatProvider の実装を指定します。The provider parameter specifies an IFormatProvider implementation that can provide formatting information for the objects in args. provider は、次のいずれかになります。provider can be any of the following:

  • カルチャ固有の書式情報を提供する CultureInfo オブジェクト。A CultureInfo object that provides culture-specific formatting information.

  • 数値の場合、arg0 にカルチャ固有の書式情報を提供する NumberFormatInfo オブジェクト。A NumberFormatInfo object that provides culture-specific formatting information for arg0 if it is a numeric value.

  • 日付と時刻の値の場合に、arg0 のカルチャ固有の書式情報を提供する DateTimeFormatInfo オブジェクト。A DateTimeFormatInfo object that provides culture-specific formatting information for arg0 if it is a date and time value.

  • arg0の書式設定情報を提供するカスタム IFormatProvider 実装。A custom IFormatProvider implementation that provides formatting information for arg0. 通常、このような実装では、ICustomFormatter インターフェイスも実装します。Typically, such an implementation also implements the ICustomFormatter interface.

provider パラメーターが null場合、書式設定情報は現在のカルチャから取得されます。If the provider parameter is null, formatting information is obtained from the current culture.

arg0 は、書式設定するオブジェクトを表します。arg0 represents the object to be formatted. format 内の各書式指定項目は、arg0の文字列形式に置き換えられます。Each format item in format is replaced with the string representation of arg0. 書式指定項目に formatString が含まれており、arg0 IFormattable インターフェイスが実装されている場合、arg0.ToString(formatString, provider) は書式設定を定義します。If the format item includes formatString and arg0 implements the IFormattable interface, then arg0.ToString(formatString, provider) defines the formatting. それ以外の場合は、arg0.ToString() によって書式設定が定義されます。Otherwise, arg0.ToString() defines the formatting.

注意 (呼び出し元)

.NET Core および .NET Framework 4.0 以降のバージョンでは、StringBuilder(Int32, Int32) コンストラクターを呼び出すことによって StringBuilder オブジェクトをインスタンス化すると、StringBuilder インスタンスの長さと容量の両方が、その MaxCapacity プロパティの値を超えて拡張される可能性があります。In .NET Core and in the .NET Framework 4.0 and later versions, when you instantiate the StringBuilder object by calling the StringBuilder(Int32, Int32) constructor, both the length and the capacity of the StringBuilder instance can grow beyond the value of its MaxCapacity property. これは、Append(String)AppendFormat(String, Object) メソッドを呼び出して小さい文字列を追加する場合に特に発生します。This can occur particularly when you call the Append(String) and AppendFormat(String, Object) methods to append small strings.

こちらもご覧ください

AppendFormat(IFormatProvider, String, Object[])

0 個以上の書式項目を含んでいる複合書式指定文字列を処理することで返される文字列を、このインスタンスに追加します。Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. 各書式項目は、指定された書式プロバイダーを使用した、パラメーター配列内の対応する引数の文字列形式に置換されます。Each format item is replaced by the string representation of a corresponding argument in a parameter array using a specified format provider.

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

カルチャ固有の書式情報を提供するオブジェクト。An object that supplies culture-specific formatting information.

format
String

複合書式設定文字列。A composite format string.

args
Object[]

書式指定するオブジェクトの配列。An array of objects to format.

戻り値

追加操作が完了した後のこのインスタンスへの参照。追加操作が完了した後のこのインスタンスへの参照。A reference to this instance after the append operation has completed. 追加操作の完了後、このインスタンスには、操作前に存在していたデータの末尾に format のコピーが付加されたものが含まれます。このコピーでは、書式指定が、対応するオブジェクト引数の文字列形式に置換されています。After the append operation, this instance contains any data that existed before the operation, suffixed by a copy of format where any format specification is replaced by the string representation of the corresponding object argument.

例外

formatnullです。format is null.

format が無効です。format is invalid.

- または --or-

書式項目のインデックスが 0 (ゼロ) 未満であるか、args 配列の長さ以上です。The index of a format item is less than 0 (zero), or greater than or equal to the length of the args array.

拡張された文字列の長さが MaxCapacity を超えます。The length of the expanded string would exceed MaxCapacity.

AppendFormatメソッドの例を次に示します。The following example demonstrates the AppendFormat method.

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

次の例では、4桁と7桁のハイフンを使用して10桁の顧客番号を書式設定する CustomerFormatter という名前のカスタム IFormatProvider 実装を定義します。The following example defines a custom IFormatProvider implementation named CustomerFormatter that formats a 10-digit customer number with hyphens after the fourth and seventh digits. これは、書式設定された顧客番号と顧客名を含む文字列を作成するために、StringBuilder.AppendFormat(IFormatProvider, String, Object[]) メソッドに渡されます。It is passed to the StringBuilder.AppendFormat(IFormatProvider, String, Object[]) method to create a string that includes the formatted customer number and customer name.

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 オブジェクトに埋め込みます。This method uses the composite formatting feature of the .NET Framework to convert the value of an object to its text representation and embed that representation in the current StringBuilder object.

format パラメーターは、このメソッドのパラメーターリスト内のオブジェクトに対応する0個以上のインデックス付きプレースホルダー (書式項目と呼ばれます) と共に、0個以上のテキストの実行で構成されます。The format parameter consists of zero or more runs of text intermixed with zero or more indexed placeholders, called format items, that correspond to objects in the parameter list of this method. 書式設定のプロセスでは、各書式項目が対応するオブジェクトの文字列形式に置き換えられます。The formatting process replaces each format item with the string representation of the corresponding object.

書式指定項目の構文は次のとおりです。The syntax of a format item is as follows:

{index[,length][:formatString]}{index[,length][:formatString]}

角かっこ内の要素は省略可能です。Elements in square brackets are optional. 次の表は、それぞれの要素の説明です。The following table describes each element.

要素Element 説明Description
indexindex 書式設定するオブジェクトのパラメーターリスト内の0から始まる位置。The zero-based position in the parameter list of the object to be formatted. Indexで指定されたオブジェクトが null場合、書式項目は String.Emptyに置き換えられます。If the object specified by index is null, the format item is replaced by String.Empty. インデックス位置にパラメーターがない場合は、FormatException がスローされます。If there is no parameter in the index position, a FormatException is thrown.
length,length パラメーターの文字列形式の最小文字数。The minimum number of characters in the string representation of the parameter. 正の場合、パラメーターは右上にあります。負の場合は、左揃えになります。If positive, the parameter is right-aligned; if negative, it is left-aligned.
:formatString:formatString パラメーターでサポートされている標準またはカスタムの書式指定文字列。A standard or custom format string that is supported by the parameter.

注意

日付と時刻の値と共に使用される標準およびカスタム書式指定文字列については、「標準の日付と時刻の書式指定文字列」および「カスタム日時書式指定文字列」を参照してください。For the standard and custom format strings used with date and time values, see Standard Date and Time Format Strings and Custom Date and Time Format Strings. 数値で使用される標準およびカスタム書式指定文字列については、「標準の数値書式指定文字列」および「カスタム数値書式指定文字列」を参照してください。For the standard and custom format strings used with numeric values, see Standard Numeric Format Strings and Custom Numeric Format Strings. 列挙体で使用される標準書式指定文字列については、「列挙型書式指定文字列」を参照してください。For the standard format strings used with enumerations, see Enumeration Format Strings.

provider パラメーターは args内のオブジェクトの書式設定情報を提供できる IFormatProvider の実装を指定します。The provider parameter specifies an IFormatProvider implementation that can provide formatting information for the objects in args. provider は、次のいずれかになります。provider can be any of the following:

provider パラメーターが nullの場合、書式プロバイダー情報は現在のカルチャから取得されます。If the provider parameter is null, format provider information is obtained from the current culture.

args は、書式設定するオブジェクトを表します。args represents the objects to be formatted. format 内の各書式指定項目は、args内の対応するオブジェクトの文字列形式に置き換えられます。Each format item in format is replaced with the string representation of the corresponding object in args. 書式指定項目に formatString が含まれており、args 内の対応するオブジェクトが IFormattable インターフェイスを実装している場合、args[index].ToString(formatString, provider) は書式設定を定義します。If the format item includes formatString and the corresponding object in args implements the IFormattable interface, then args[index].ToString(formatString, provider) defines the formatting. それ以外の場合は、args[index].ToString() によって書式設定が定義されます。Otherwise, args[index].ToString() defines the formatting.

注意 (呼び出し元)

.NET Core および .NET Framework 4.0 以降のバージョンでは、StringBuilder(Int32, Int32) コンストラクターを呼び出すことによって StringBuilder オブジェクトをインスタンス化すると、StringBuilder インスタンスの長さと容量の両方が、その MaxCapacity プロパティの値を超えて拡張される可能性があります。In .NET Core and in the .NET Framework 4.0 and later versions, when you instantiate the StringBuilder object by calling the StringBuilder(Int32, Int32) constructor, both the length and the capacity of the StringBuilder instance can grow beyond the value of its MaxCapacity property. これは、Append(String)AppendFormat(String, Object) メソッドを呼び出して小さい文字列を追加する場合に特に発生します。This can occur particularly when you call the Append(String) and AppendFormat(String, Object) methods to append small strings.

こちらもご覧ください

AppendFormat(String, Object, Object)

0 個以上の書式項目を含んでいる複合書式指定文字列を処理することで返される文字列を、このインスタンスに追加します。Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. 各書式項目は、2 つの引数のどちらかの文字列形式に置換されます。Each format item is replaced by the string representation of either of two arguments.

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

複合書式設定文字列。A composite format string.

arg0
Object

1 番目に書式設定するオブジェクト。The first object to format.

arg1
Object

2 番目に書式設定するオブジェクト。The second object to format.

戻り値

format が追加されたこのインスタンスへの参照。A reference to this instance with format appended. format の各書式項目は、対応するオブジェクト引数の文字列形式に置換されます。Each format item in format is replaced by the string representation of the corresponding object argument.

例外

formatnull です。format is null.

format が無効です。format is invalid.

- または --or-

書式項目のインデックスが 0 (ゼロ) 未満か、または 2 以上です。The index of a format item is less than 0 (zero), or greater than or equal to 2.

拡張された文字列の長さが MaxCapacity を超えます。The length of the expanded string would exceed MaxCapacity.

AppendFormatメソッドの例を次に示します。The following example demonstrates the AppendFormat method.

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 オブジェクトに埋め込みます。This method uses the composite formatting feature of the .NET Framework to convert the value of an object to its text representation and embed that representation in the current StringBuilder object.

format パラメーターは、このメソッドのパラメーターリストに含まれる2つのオブジェクトの arg0arg1に対応する書式項目と呼ばれる0個以上のインデックス付きプレースホルダーと共に、0個以上のテキストの実行で構成されます。The format parameter consists of zero or more runs of text intermixed with zero or more indexed placeholders, called format items, that correspond to arg0 and arg1, the two objects in the parameter list of this method. 書式設定のプロセスでは、各書式項目が対応するオブジェクトの文字列形式に置き換えられます。The formatting process replaces each format item with the string representation of the corresponding object.

書式指定項目の構文は次のとおりです。The syntax of a format item is as follows:

{index[,length][:formatString]}{index[,length][:formatString]}

角かっこ内の要素は省略可能です。Elements in square brackets are optional. 次の表は、それぞれの要素の説明です。The following table describes each element.

要素Element 説明Description
indexindex 書式設定するオブジェクトのパラメーターリスト内の0から始まる位置。The zero-based position in the parameter list of the object to be formatted. Indexで指定されたオブジェクトが null場合、書式項目は String.Emptyに置き換えられます。If the object specified by index is null, the format item is replaced by String.Empty. インデックス位置にパラメーターがない場合は、FormatException がスローされます。If there is no parameter in the index position, a FormatException is thrown.
length,length パラメーターの文字列形式の最小文字数。The minimum number of characters in the string representation of the parameter. 正の場合、パラメーターは右上にあります。負の場合は、左揃えになります。If positive, the parameter is right-aligned; if negative, it is left-aligned.
:formatString:formatString パラメーターでサポートされている標準またはカスタムの書式指定文字列。A standard or custom format string that is supported by the parameter.

注意

日付と時刻の値と共に使用される標準およびカスタム書式指定文字列については、「標準の日付と時刻の書式指定文字列」および「カスタム日時書式指定文字列」を参照してください。For the standard and custom format strings used with date and time values, see Standard Date and Time Format Strings and Custom Date and Time Format Strings. 数値で使用される標準およびカスタム書式指定文字列については、「標準の数値書式指定文字列」および「カスタム数値書式指定文字列」を参照してください。For the standard and custom format strings used with numeric values, see Standard Numeric Format Strings and Custom Numeric Format Strings. 列挙体で使用される標準書式指定文字列については、「列挙型書式指定文字列」を参照してください。For the standard format strings used with enumerations, see Enumeration Format Strings.

arg0arg1 は、書式設定するオブジェクトを表します。arg0 and arg1 represent the objects to be formatted. format 内の各書式指定項目は、arg0 または arg1の文字列形式に置き換えられます。Each format item in format is replaced with the string representation of either arg0 or arg1. 書式指定項目に formatString が含まれており、対応するオブジェクトが IFormattable インターフェイスを実装している場合、argx.ToString(formatString, provider) は書式を定義します。ここで、 xは引数のインデックスです。If the format item includes formatString and the corresponding object implements the IFormattable interface, then argx.ToString(formatString, provider) defines the formatting, where x is the index of the argument. それ以外の場合は、argx.ToString() によって書式設定が定義されます。Otherwise, argx.ToString() defines the formatting.

format に割り当てられた文字列が "{0: # # # #} の食料を慈善団体に寄付しようとしています" という内容の場合は、If the string assigned to format is "Thank you for your donation of {0:####} cans of food to our charitable organization." また arg0 は値が10の整数です。この戻り値は、"私たちの慈善団体に対して10人の食べ物を寄付したとしていただき、ありがとうございました" となります。and arg0 is an integer with the value 10, the return value will be "Thank you for your donation of 10 cans of food to our charitable organization."

注意 (呼び出し元)

.NET Core および .NET Framework 4.0 以降のバージョンでは、StringBuilder(Int32, Int32) コンストラクターを呼び出すことによって StringBuilder オブジェクトをインスタンス化すると、StringBuilder インスタンスの長さと容量の両方が、その MaxCapacity プロパティの値を超えて拡張される可能性があります。In .NET Core and in the .NET Framework 4.0 and later versions, when you instantiate the StringBuilder object by calling the StringBuilder(Int32, Int32) constructor, both the length and the capacity of the StringBuilder instance can grow beyond the value of its MaxCapacity property. これは、Append(String)AppendFormat(String, Object) メソッドを呼び出して小さい文字列を追加する場合に特に発生します。This can occur particularly when you call the Append(String) and AppendFormat(String, Object) methods to append small strings.

こちらもご覧ください

AppendFormat(IFormatProvider, String, Object, Object)

0 個以上の書式項目を含んでいる複合書式指定文字列を処理することで返される文字列を、このインスタンスに追加します。Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. 各書式項目は、指定された書式プロバイダーを使用して 2 つの引数のいずれかの文字列形式に置換されます。Each format item is replaced by the string representation of either of two arguments using a specified format provider.

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

カルチャ固有の書式情報を提供するオブジェクト。An object that supplies culture-specific formatting information.

format
String

複合書式設定文字列。A composite format string.

arg0
Object

1 番目に書式設定するオブジェクト。The first object to format.

arg1
Object

2 番目に書式設定するオブジェクト。The second object to format.

戻り値

追加操作が完了した後のこのインスタンスへの参照。追加操作が完了した後のこのインスタンスへの参照。A reference to this instance after the append operation has completed. 追加操作の完了後、このインスタンスには、操作前に存在していたデータの末尾に format のコピーが付加されたものが含まれます。このコピーでは、書式指定が、対応するオブジェクト引数の文字列形式に置換されています。After the append operation, this instance contains any data that existed before the operation, suffixed by a copy of format where any format specification is replaced by the string representation of the corresponding object argument.

例外

formatnull です。format is null.

format が無効です。format is invalid.

- または --or-

書式項目のインデックスが 0 (ゼロ) 未満か、または 2 以上です。The index of a format item is less than 0 (zero), or greater than or equal to 2 (two).

拡張された文字列の長さが MaxCapacity を超えます。The length of the expanded string would exceed MaxCapacity.

次の例では、AppendFormat(IFormatProvider, String, Object, Object) メソッドを使用して、ジェネリック Dictionary<TKey,TValue> オブジェクトに格納されている時間と気温のデータを表示します。The following example uses the AppendFormat(IFormatProvider, String, Object, Object) method to display time and temperature data stored in a generic Dictionary<TKey,TValue> object. 書式指定文字列には、書式設定するオブジェクトだけではなく、3つの書式項目があることに注意してください。Note that the format string has three format items, although there are only to objects to format. これは、リスト内の最初のオブジェクト (日付と時刻の値) が2つの書式指定項目によって使用されるためです。最初の書式項目は時刻を表示し、2番目のオブジェクトは日付を表示します。This is because the first object in the list (a date and time value) is used by two format items: The first format item displays the time, and the second displays the date.

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 オブジェクトに埋め込みます。This method uses the composite formatting feature of the .NET Framework to convert the value of an object to its text representation and embed that representation in the current StringBuilder object.

format パラメーターは、このメソッドのパラメーターリスト内のオブジェクトに対応する0個以上のインデックス付きプレースホルダー (書式項目と呼ばれます) と共に、0個以上のテキストの実行で構成されます。The format parameter consists of zero or more runs of text intermixed with zero or more indexed placeholders, called format items, that correspond to objects in the parameter list of this method. 書式設定のプロセスでは、各書式項目が対応するオブジェクトの文字列形式に置き換えられます。The formatting process replaces each format item with the string representation of the corresponding object.

書式指定項目の構文は次のとおりです。The syntax of a format item is as follows:

{index[,length][:formatString]}{index[,length][:formatString]}

角かっこ内の要素は省略可能です。Elements in square brackets are optional. 次の表は、それぞれの要素の説明です。The following table describes each element.

要素Element 説明Description
indexindex 書式設定するオブジェクトのパラメーターリスト内の0から始まる位置。The zero-based position in the parameter list of the object to be formatted. Indexで指定されたオブジェクトが null場合、書式項目は String.Emptyに置き換えられます。If the object specified by index is null, the format item is replaced by String.Empty. インデックス位置にパラメーターがない場合は、FormatException がスローされます。If there is no parameter in the index position, a FormatException is thrown.
length,length パラメーターの文字列形式の最小文字数。The minimum number of characters in the string representation of the parameter. 正の場合、パラメーターは右上にあります。負の場合は、左揃えになります。If positive, the parameter is right-aligned; if negative, it is left-aligned.
:formatString:formatString パラメーターでサポートされている標準またはカスタムの書式指定文字列。A standard or custom format string that is supported by the parameter.

注意

日付と時刻の値と共に使用される標準およびカスタム書式指定文字列については、「標準の日付と時刻の書式指定文字列」および「カスタム日時書式指定文字列」を参照してください。For the standard and custom format strings used with date and time values, see Standard Date and Time Format Strings and Custom Date and Time Format Strings. 数値で使用される標準およびカスタム書式指定文字列については、「標準の数値書式指定文字列」および「カスタム数値書式指定文字列」を参照してください。For the standard and custom format strings used with numeric values, see Standard Numeric Format Strings and Custom Numeric Format Strings. 列挙体で使用される標準書式指定文字列については、「列挙型書式指定文字列」を参照してください。For the standard format strings used with enumerations, see Enumeration Format Strings.

provider パラメーターは、arg0arg1の書式設定情報を提供できる IFormatProvider の実装を指定します。The provider parameter specifies an IFormatProvider implementation that can provide formatting information for arg0 and arg1. provider は、次のいずれかになります。provider can be any of the following:

  • カルチャ固有の書式情報を提供する CultureInfo オブジェクト。A CultureInfo object that provides culture-specific formatting information.

  • 数値の場合、arg0 または arg1 にカルチャ固有の書式情報を提供する NumberFormatInfo オブジェクト。A NumberFormatInfo object that provides culture-specific formatting information for arg0 or arg1 if they are numeric values.

  • 日付と時刻の値の場合、arg0 または arg1 にカルチャ固有の書式情報を提供する DateTimeFormatInfo オブジェクト。A DateTimeFormatInfo object that provides culture-specific formatting information for arg0 or arg1 if they are date and time values.

  • arg0 および arg1の書式設定情報を提供するカスタム IFormatProvider 実装。A custom IFormatProvider implementation that provides formatting information for arg0 and arg1. 通常、このような実装では、ICustomFormatter インターフェイスも実装します。Typically, such an implementation also implements the ICustomFormatter interface.

provider パラメーターが nullの場合、書式プロバイダー情報は現在のカルチャから取得されます。If the provider parameter is null, format provider information is obtained from the current culture.

arg0arg1 は、書式設定するオブジェクトを表します。arg0 and arg1 represent the objects to be formatted. format 内の各書式指定項目は、対応するインデックスを持つオブジェクトの文字列形式に置き換えられます。Each format item in format is replaced with the string representation of the object that has the corresponding index. 書式指定項目に formatString が含まれていて、対応する引数が IFormattable インターフェイスを実装している場合は、引数の ToString(formatString, provider) メソッドによって書式設定が定義されます。If the format item includes formatString and the corresponding argument implements the IFormattable interface, then the argument's ToString(formatString, provider) method defines the formatting. それ以外の場合は、引数の ToString() メソッドによって書式設定が定義されます。Otherwise, the argument's ToString() method defines the formatting.

注意 (呼び出し元)

プロファイリング .NET Core と .NET Framework 4.0 以降のバージョンでは、StringBuilder(Int32, Int32) コンストラクターを呼び出すことによって StringBuilder オブジェクトをインスタンス化すると、StringBuilder インスタンスの長さと容量の両方が、その MaxCapacity プロパティの値を超える可能性があります。IIn .NET Core and in the .NET Framework 4.0 and later versions, when you instantiate the StringBuilder object by calling the StringBuilder(Int32, Int32) constructor, both the length and the capacity of the StringBuilder instance can grow beyond the value of its MaxCapacity property. これは、Append(String)AppendFormat(String, Object) メソッドを呼び出して小さい文字列を追加する場合に特に発生します。This can occur particularly when you call the Append(String) and AppendFormat(String, Object) methods to append small strings.

こちらもご覧ください

AppendFormat(String, Object, Object, Object)

0 個以上の書式項目を含んでいる複合書式指定文字列を処理することで返される文字列を、このインスタンスに追加します。Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. 各書式項目は、3 つの引数のいずれかの文字列形式に置換されます。Each format item is replaced by the string representation of either of three arguments.

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

複合書式設定文字列。A composite format string.

arg0
Object

1 番目に書式設定するオブジェクト。The first object to format.

arg1
Object

2 番目に書式設定するオブジェクト。The second object to format.

arg2
Object

3 番目に書式設定するオブジェクト。3 番目に書式設定するオブジェクト。The third object to format.

戻り値

format が追加されたこのインスタンスへの参照。A reference to this instance with format appended. format の各書式項目は、対応するオブジェクト引数の文字列形式に置換されます。Each format item in format is replaced by the string representation of the corresponding object argument.

例外

formatnull です。format is null.

format が無効です。format is invalid.

- または --or-

書式項目のインデックスが 0 (ゼロ) 未満か、または 3 以上です。The index of a format item is less than 0 (zero), or greater than or equal to 3.

拡張された文字列の長さが MaxCapacity を超えます。The length of the expanded string would exceed MaxCapacity.

AppendFormatメソッドの例を次に示します。The following example demonstrates the AppendFormat method.

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 オブジェクトに埋め込みます。This method uses the composite formatting feature of the .NET Framework to convert the value of an object to its text representation and embed that representation in the current StringBuilder object.

format パラメーターは、書式指定項目と呼ばれる0個以上のインデックス付きプレースホルダーと共に、0個以上のテキストの実行で構成されます。これは、このメソッドのパラメーターリスト内のオブジェクト arg2によって arg0 に対応します。The format parameter consists of zero or more runs of text intermixed with zero or more indexed placeholders, called format items, that correspond to arg0 through arg2, the objects in the parameter list of this method. 書式設定のプロセスでは、各書式項目が対応するオブジェクトの文字列形式に置き換えられます。The formatting process replaces each format item with the string representation of the corresponding object.

書式指定項目の構文は次のとおりです。The syntax of a format item is as follows:

{index[,length][:formatString]}{index[,length][:formatString]}

角かっこ内の要素は省略可能です。Elements in square brackets are optional. 次の表は、それぞれの要素の説明です。The following table describes each element.

要素Element 説明Description
indexindex 書式設定するオブジェクトのパラメーターリスト内の0から始まる位置。The zero-based position in the parameter list of the object to be formatted. Indexで指定されたオブジェクトが null場合、書式項目は String.Emptyに置き換えられます。If the object specified by index is null, the format item is replaced by String.Empty. インデックス位置にパラメーターがない場合は、FormatException がスローされます。If there is no parameter in the index position, a FormatException is thrown.
length,length パラメーターの文字列形式の最小文字数。The minimum number of characters in the string representation of the parameter. 正の場合、パラメーターは右上にあります。負の場合は、左揃えになります。If positive, the parameter is right-aligned; if negative, it is left-aligned.
:formatString:formatString パラメーターでサポートされている標準またはカスタムの書式指定文字列。A standard or custom format string that is supported by the parameter.

注意

日付と時刻の値と共に使用される標準およびカスタム書式指定文字列については、「標準の日付と時刻の書式指定文字列」および「カスタム日時書式指定文字列」を参照してください。For the standard and custom format strings used with date and time values, see Standard Date and Time Format Strings and Custom Date and Time Format Strings. 数値で使用される標準およびカスタム書式指定文字列については、「標準の数値書式指定文字列」および「カスタム数値書式指定文字列」を参照してください。For the standard and custom format strings used with numeric values, see Standard Numeric Format Strings and Custom Numeric Format Strings. 列挙体で使用される標準書式指定文字列については、「列挙型書式指定文字列」を参照してください。For the standard format strings used with enumerations, see Enumeration Format Strings.

arg0arg1、および arg2 は、書式設定するオブジェクトを表します。arg0, arg1, and arg2 represent the objects to be formatted. format の各書式指定項目は、書式項目のインデックスに応じて、arg0arg1、または arg2のいずれかの文字列形式に置き換えられます。Each format item in format is replaced with the string representation of either arg0, arg1, or arg2, depending on the index of the format item. 書式指定項目に formatString が含まれており、args 内の対応するオブジェクトが IFormattable インターフェイスを実装している場合、argx.ToString(formatString, null) は書式を定義します。ここで、 xは引数のインデックスです。If the format item includes formatString and the corresponding object in args implements the IFormattable interface, then argx.ToString(formatString, null) defines the formatting, where x is the index of the argument. それ以外の場合は、argx.ToString() によって書式設定が定義されます。Otherwise, argx.ToString() defines the formatting.

format に割り当てられた文字列が "{0: # # # #} の食料を慈善団体に寄付しようとしています" という内容の場合は、If the string assigned to format is "Thank you for your donation of {0:####} cans of food to our charitable organization." また arg0 は値が10の整数です。この戻り値は、"私たちの慈善団体に対して10人の食べ物を寄付したとしていただき、ありがとうございました" となります。and arg0 is an integer with the value 10, the return value will be "Thank you for your donation of 10 cans of food to our charitable organization."

注意 (呼び出し元)

.NET Core および .NET Framework 4.0 以降のバージョンでは、StringBuilder(Int32, Int32) コンストラクターを呼び出すことによって StringBuilder オブジェクトをインスタンス化すると、StringBuilder インスタンスの長さと容量の両方が、その MaxCapacity プロパティの値を超えて拡張される可能性があります。In .NET Core and in the .NET Framework 4.0 and later versions, when you instantiate the StringBuilder object by calling the StringBuilder(Int32, Int32) constructor, both the length and the capacity of the StringBuilder instance can grow beyond the value of its MaxCapacity property. これは、Append(String)AppendFormat(String, Object) メソッドを呼び出して小さい文字列を追加する場合に特に発生します。This can occur particularly when you call the Append(String) and AppendFormat(String, Object) methods to append small strings.

こちらもご覧ください

適用対象