StringBuilder.AppendFormat Method (IFormatProvider, String, array<Object[])

Parameters

• provider
  Type: System.IFormatProvider
  An object that supplies culture-specific formatting information.

• format
  Type: System.String
  A composite format string (see Remarks).

• args
  Type: array<System.Object[]
  An array of objects to format.

Return Value

Type: System.Text.StringBuilder
A reference to this instance after the append operation has completed. After the append operation, this instance contains any data that existed before the operation, suffixed by a copy of format, where each format item is replaced by the string representation of the corresponding object argument.

Imports System.Text
Imports System.Globalization

Class Example
   Private Shared sb As New StringBuilder()

   Public Shared Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)
      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}

      outputBlock.Text &= vbCrLf
      outputBlock.Text &= "StringBuilder.AppendFormat method:" & vbCrLf
      sb.AppendFormat("1) {0}", var1)
      Show(outputBlock, sb)
      sb.AppendFormat("2) {0}, {1}", var1, var2)
      Show(outputBlock, sb)
      sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3)
      Show(outputBlock, sb)
      sb.AppendFormat("4) {0}, {1}, {2}", var4)
      Show(outputBlock, sb)
      Dim ci As New CultureInfo("es-ES")
      sb.AppendFormat(ci, "5) {0}", var2)
      Show(outputBlock, sb)
   End Sub 'Main

   Public Shared Sub Show(ByVal outputBlock As System.Windows.Controls.TextBlock, ByVal sbs As StringBuilder)
      outputBlock.Text &= sbs.ToString() & vbCrLf
      sb.Length = 0
   End Sub 'Show
End Class 'Sample
'
'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 Example
{
   static StringBuilder sb = new StringBuilder();

   public static void Demo(System.Windows.Controls.TextBlock outputBlock)
   {
      int var1 = 111;
      float var2 = 2.22F;
      string var3 = "abcd";
      object[] var4 = { 3, 4.4, 'X' };

      outputBlock.Text += "\n";
      outputBlock.Text += "StringBuilder.AppendFormat method:" + "\n";
      sb.AppendFormat("1) {0}", var1);
      Show(outputBlock, sb);
      sb.AppendFormat("2) {0}, {1}", var1, var2);
      Show(outputBlock, sb);
      sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3);
      Show(outputBlock, sb);
      sb.AppendFormat("4) {0}, {1}, {2}", var4);
      Show(outputBlock, sb);
      CultureInfo ci = new CultureInfo("es-ES");
      sb.AppendFormat(ci, "5) {0}", var2);
      Show(outputBlock, sb);
   }

   public static void Show(System.Windows.Controls.TextBlock outputBlock, StringBuilder sbs)
   {
      outputBlock.Text += sbs.ToString() + "\n";
      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

Public Class Customer
   Private custName As String
   Private custNumber As Integer

   Public Sub New(ByVal name As String, ByVal 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(ByVal 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(ByVal fmt As String, ByVal arg As Object, ByVal 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 Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)
      Dim customer As New Customer("A Plus Software", 903654)
      Dim sb As New StringBuilder()
      sb.AppendFormat(New CustomerNumberFormatter, "{0}: {1}", _
                      customer.CustomerNumber, customer.Name)
      outputBlock.Text &= sb.ToString() & vbCrLf
   End Sub
End Module
' The example displays the following output:
'      0000-903-654: A Plus Software

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 Demo(System.Windows.Controls.TextBlock outputBlock)
   {
      Customer customer = new Customer("A Plus Software", 903654);
      StringBuilder sb = new StringBuilder();
      sb.AppendFormat(new CustomerNumberFormatter(), "{0}: {1}",
                      customer.CustomerNumber, customer.Name);
      outputBlock.Text += sb.ToString() + "\n";
   }
}
// The example displays the following output:
//      0000-903-654: A Plus Software