StringBuilder.AppendFormat Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Добавляет к данному экземпляру строку, возвращаемую в результате обработки строки составного формата, содержащей ноль или более элементов формата. Каждый элемент формата заменяется строковым представлением соответствующего аргумента объекта.
Перегрузки
AppendFormat(IFormatProvider, String, Object, Object, Object) |
Добавляет к данному экземпляру строку, возвращаемую в результате обработки строки составного формата, содержащей ноль или более элементов формата. Каждый элемент формата заменяется строковым представлением любого из трех аргументов с помощью указанного поставщика формата. |
AppendFormat(String, Object) |
Добавляет к данному экземпляру строку, возвращаемую в результате обработки строки составного формата, содержащей ноль или более элементов формата. Каждый элемент формата заменяется строковым представлением одного аргумента. |
AppendFormat(String, Object[]) |
Добавляет к данному экземпляру строку, возвращаемую в результате обработки строки составного формата, содержащей ноль или более элементов формата. Каждый элемент формата заменяется строковым представлением соответствующего аргумента в массиве параметров. |
AppendFormat(IFormatProvider, String, Object) |
Добавляет к данному экземпляру строку, возвращаемую в результате обработки строки составного формата, содержащей ноль или более элементов формата. Каждый элемент формата заменяется строковым представлением одного аргумента с использованием указанного поставщика формата. |
AppendFormat(IFormatProvider, String, Object[]) |
Добавляет к данному экземпляру строку, возвращаемую в результате обработки строки составного формата, содержащей ноль или более элементов формата. Каждый элемент формата заменяется строковым представлением соответствующего аргумента в массиве параметров с помощью указанного поставщика формата. |
AppendFormat(String, Object, Object) |
Добавляет к данному экземпляру строку, возвращаемую в результате обработки строки составного формата, содержащей ноль или более элементов формата. Каждый элемент формата заменяется строковым представлением любого из двух аргументов. |
AppendFormat(IFormatProvider, String, Object, Object) |
Добавляет к данному экземпляру строку, возвращаемую в результате обработки строки составного формата, содержащей ноль или более элементов формата. Каждый элемент формата заменяется строковым представлением любого из двух аргументов с помощью указанного поставщика формата. |
AppendFormat(String, Object, Object, Object) |
Добавляет к данному экземпляру строку, возвращаемую в результате обработки строки составного формата, содержащей ноль или более элементов формата. Каждый элемент формата заменяется строковым представлением любого из трех аргументов. |
AppendFormat(IFormatProvider, String, Object, Object, Object)
Добавляет к данному экземпляру строку, возвращаемую в результате обработки строки составного формата, содержащей ноль или более элементов формата. Каждый элемент формата заменяется строковым представлением любого из трех аргументов с помощью указанного поставщика формата.
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
Первый объект для форматирования.
- arg1
- Object
Второй объект для форматирования.
- arg2
- Object
Третий объект для форматирования.
Возвращаемое значение
Ссылка на этот экземпляр после завершения операции добавления. После операции добавления этот экземпляр содержит все данные, существовавшие до операции, к которым добавляется копия параметра format
, где все спецификации форматирования заменяются представлением строки соответствующего аргумента объекта.
Исключения
format
имеет значение null
.
Длина развернутой строки превысила бы MaxCapacity.
Примеры
В следующем примере метод используется AppendFormat(IFormatProvider, String, Object, Object, Object) для иллюстрации результата логической And
операции с целыми значениями. Обратите внимание, что строка форматирования содержит шесть элементов формата, но метод содержит только три элемента в списке аргументов, так как каждый элемент форматируется двумя разными способами.
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 объект.
Параметр format
состоит из нуля или нескольких выполнений текста, пересекающихся с нуля или более индексированных заполнителей, называемых элементами форматирования, которые соответствуют объектам в списке параметров этого метода. Процесс форматирования заменяет каждый элемент форматирования строковым представлением соответствующего объекта.
Синтаксис элемента формата выглядит следующим образом:
{index[,length][:formatString]}
Элементы в квадратных скобках являются необязательными. Каждый из элементов описан в таблице ниже.
Элемент | Описание |
---|---|
index | Отсчитываемая от нуля позиция в списке параметров отформатированного объекта. Если объект, указанный индексомnull , заменяется String.Emptyэлементом формата. Если в позиции индекса нет параметра, FormatException создается исключение. |
,length | Минимальное количество символов в строковом представлении параметра. Если положительный результат, параметр выравнивается по правому краю; Если отрицательный, он выравнивается по левому краю. |
:formatString | Строка стандартного или настраиваемого формата, поддерживаемая параметром. |
Примечание
Строки стандартного и настраиваемого формата, используемые со значениями даты и времени, см. в разделе "Стандартные строки формата даты и времени " и "Настраиваемые строки формата даты и времени". Строки стандартного и настраиваемого формата, используемые с числовыми значениями, см. в разделе "Стандартные числовые строки" и "Строки настраиваемого числового формата". Строки стандартного формата, используемые с перечислениями, см. в разделе "Строки формата перечисления".
Параметр provider
указывает реализацию IFormatProvider , которая может предоставлять сведения о форматировании и arg0
arg1
. Параметр provider
может иметь любое из следующих значений.
Объект 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) методах для добавления небольших строк.
См. также раздел
- Типы форматирования в .NET
- Составное форматирование
- Практическое руководство. Определение и использование поставщиков настраиваемых числовых форматов
- Строки стандартных числовых форматов
- Строки настраиваемых числовых форматов
- Строки стандартных форматов даты и времени
- Строки настраиваемых форматов даты и времени
- Строки стандартного формата TimeSpan
- Строки пользовательского формата TimeSpan
- Строки форматов перечисления
Применяется к
AppendFormat(String, Object)
Добавляет к данному экземпляру строку, возвращаемую в результате обработки строки составного формата, содержащей ноль или более элементов формата. Каждый элемент формата заменяется строковым представлением одного аргумента.
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
Объект для форматирования.
Возвращаемое значение
Ссылка на данный экземпляр с добавленным format
. Каждый элемент формата в параметре format
заменяется строковым представлением параметра arg0
.
Исключения
format
имеет значение null
.
Длина развернутой строки превысила бы 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, чтобы соответствовать arg0
одному объекту в списке параметров этого метода. Процесс форматирования заменяет каждый элемент формата строковым представлением arg0
.
Синтаксис элемента формата выглядит следующим образом:
{index[,length][:formatString]}
Элементы в квадратных скобках являются необязательными. Каждый из элементов описан в таблице ниже.
Элемент | Описание |
---|---|
index | Отсчитываемая от нуля позиция в списке параметров отформатированного объекта. Если объект, указанный индексомnull , заменяется String.Emptyэлементом формата. Если в позиции индекса нет параметра, FormatException создается исключение. |
,length | Минимальное количество символов в строковом представлении параметра. Если положительный результат, параметр выравнивается по правому краю; Если отрицательный, он выравнивается по левому краю. |
:formatString | Строка стандартного или настраиваемого формата, поддерживаемая параметром. |
Примечание
Строки стандартного и настраиваемого формата, используемые со значениями даты и времени, см. в разделе "Стандартные строки формата даты и времени " и "Настраиваемые строки формата даты и времени". Строки стандартного и настраиваемого формата, используемые с числовыми значениями, см. в разделе "Стандартные числовые строки" и "Строки настраиваемого числового формата". Строки стандартного формата, используемые с перечислениями, см. в разделе "Строки формата перечисления".
arg0
представляет объект для форматирования. Каждый элемент format
формата заменяется строковым представлением arg0
. Если элемент формата включает formatString
и arg0
реализует IFormattable интерфейс, arg0.ToString(formatString, null)
определяет форматирование. arg0.ToString()
В противном случае определяет форматирование.
Если строка назначена format
: "Спасибо за ваше пожертвование {0:#####} продуктов питания нашей благотворительной организации". и arg0
является целым числом со значением 10, возвращаемое значение будет "Спасибо за ваше пожертвование 10 канит продуктов питания нашей благотворительной организации".
Примечания для тех, кто вызывает этот метод
В .NET Core и в платформа .NET Framework версии 4.0 и более поздних версий при создании экземпляра StringBuilder объекта путем вызова конструктора StringBuilder(Int32, Int32) длина и емкость экземпляра StringBuilder могут превышать значение его MaxCapacity свойства. Это может произойти особенно при вызове Append(String) и AppendFormat(String, Object) методах для добавления небольших строк.
См. также раздел
- Типы форматирования в .NET
- Составное форматирование
- Строки стандартных числовых форматов
- Строки настраиваемых числовых форматов
- Строки стандартных форматов даты и времени
- Строки настраиваемых форматов даты и времени
- Строки стандартного формата TimeSpan
- Строки пользовательского формата TimeSpan
- Строки форматов перечисления
Применяется к
AppendFormat(String, Object[])
Добавляет к данному экземпляру строку, возвращаемую в результате обработки строки составного формата, содержащей ноль или более элементов формата. Каждый элемент формата заменяется строковым представлением соответствующего аргумента в массиве параметров.
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[]
Массив объектов для форматирования.
Возвращаемое значение
Ссылка на данный экземпляр с добавленным format
. Каждый элемент формата в параметре format
заменяется строковым представлением соответствующего аргумента объекта.
Исключения
Параметр format
или args
имеет значение null
.
format
недопустим.
-или-
Индекс элемента формата меньше нуля или больше либо равен длине массива 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
состоит из нуля или нескольких выполнений текста, пересекающихся с нуля или более индексированных заполнителей, называемых элементами форматирования, которые соответствуют объектам в списке параметров этого метода. Процесс форматирования заменяет каждый элемент форматирования строковым представлением соответствующего объекта.
Синтаксис элемента формата выглядит следующим образом:
{index[,length][:formatString]}
Элементы в квадратных скобках являются необязательными. Каждый из элементов описан в таблице ниже.
Элемент | Описание |
---|---|
index | Отсчитываемая от нуля позиция в списке параметров отформатированного объекта. Если объект, указанный индексомnull , заменяется String.Emptyэлементом формата. Если в позиции индекса нет параметра, FormatException создается исключение. |
,length | Минимальное количество символов в строковом представлении параметра. Если положительный результат, параметр выравнивается по правому краю; Если отрицательный, он выравнивается по левому краю. |
:formatString | Строка стандартного или настраиваемого формата, поддерживаемая параметром. |
Примечание
Строки стандартного и настраиваемого формата, используемые со значениями даты и времени, см. в разделе "Стандартные строки формата даты и времени " и "Настраиваемые строки формата даты и времени". Строки стандартного и настраиваемого формата, используемые с числовыми значениями, см. в разделе "Стандартные числовые строки" и "Строки настраиваемого числового формата". Строки стандартного формата, используемые с перечислениями, см. в разделе "Строки формата перечисления".
args
представляет объекты для форматирования. Каждый элемент format
формата заменяется строковым представлением соответствующего объекта в args
. Если элемент формата включает formatString
и соответствующий объект в args
реализации IFormattable интерфейса, args[index].ToString(formatString, provider)
определяет форматирование. args[index].ToString()
В противном случае определяет форматирование.
Если строка назначена format
: "Спасибо за ваше пожертвование {0:####} продуктов питания в нашу благотворительную организацию". и arg0
является целым числом со значением 10, возвращаемое значение будет "Спасибо за ваше пожертвование 10 канит продовольствия нашей благотворительной организации".
Примечания для тех, кто вызывает этот метод
В .NET Core и в платформа .NET Framework 4.0 и более поздних версиях при создании экземпляра StringBuilder объекта путем вызова StringBuilder(Int32, Int32) конструктора длина и емкость экземпляра StringBuilder могут превысить значение его MaxCapacity свойства. Это может произойти, особенно при вызове Append(String) и AppendFormat(String, Object) методах для добавления небольших строк.
См. также раздел
- Типы форматирования в .NET
- Составное форматирование
- Строки стандартных числовых форматов
- Строки настраиваемых числовых форматов
- Строки стандартных форматов даты и времени
- Строки настраиваемых форматов даты и времени
- Строки стандартного формата TimeSpan
- Строки пользовательского формата TimeSpan
- Строки форматов перечисления
Применяется к
AppendFormat(IFormatProvider, String, Object)
Добавляет к данному экземпляру строку, возвращаемую в результате обработки строки составного формата, содержащей ноль или более элементов формата. Каждый элемент формата заменяется строковым представлением одного аргумента с использованием указанного поставщика формата.
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
Объект для форматирования.
Возвращаемое значение
Ссылка на этот экземпляр после завершения операции добавления. После операции добавления этот экземпляр содержит все данные, существовавшие до операции, к которым добавляется копия параметра format
, где все спецификации форматирования заменяются представлением arg0
.
Исключения
format
имеет значение null
.
format
недопустим.
-или-
Индекс элемента формата меньше нуля или больше либо равен единице.
Длина развернутой строки превысила бы MaxCapacity.
Примеры
Ниже приведены два вызова AppendFormat(IFormatProvider, String, Object) метода. Оба используют соглашения о форматировании языка и региональных параметров English-Great Великобритании (en-GB). Первая вставка строкового Decimal представления валюты значения в результирующем строке. Вторая вставляет 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 объект.
Параметр format
состоит из нуля или нескольких выполнений текста, чередуемых с нуля или несколькими индексированных заполнителей, называемых элементами форматирования. Индекс каждого элемента формата должен быть равен нулю (0), так как этот метод содержит список аргументов с одним аргументом. Процесс форматирования заменяет каждый элемент форматирования строковым представлением arg0
.
Синтаксис элемента форматирования выглядит следующим образом:
{index[,length][:formatString]}
Элементы в квадратных скобках являются необязательными. Каждый из элементов описан в таблице ниже.
Элемент | Описание |
---|---|
index | Отсчитываемая от нуля позиция в списке параметров объекта для форматирования. Если объект, заданный индексомnull , заменяется элементом String.Emptyформатирования. В этом случае, так как AppendFormat(IFormatProvider, String, Object) метод имеет один аргумент в списке аргументов, значение индекса всегда должно быть равно 0. Если это не так, создается исключение FormatException . |
,length | Минимальное число символов в строковом представлении параметра. Если положительный результат, параметр выравнивается по правому краю; Если отрицательный, он выравнивается по левому краю. |
:formatString | Строка стандартного или настраиваемого формата, поддерживаемая параметром. |
Примечание
Строки стандартного и настраиваемого формата, используемые со значениями даты и времени, см. в разделе "Стандартные строки формата даты и времени ", а также строки настраиваемого формата даты и времени. Строки стандартного и настраиваемого формата, используемые с числовыми значениями, см. в разделе " Строки стандартного числового формата " и "Строки настраиваемого числового формата". Строки стандартного формата, используемые с перечислениями, см. в разделе "Строки формата перечисления".
Параметр provider
задает реализацию IFormatProvider , которая может предоставлять сведения о форматировании для объектов в args
. Параметр provider
может иметь любое из следующих значений.
Объект CultureInfo , предоставляющий сведения о форматировании, зависящие от языка и региональных параметров.
Объект NumberFormatInfo , предоставляющий сведения о форматировании, зависящие от языка и региональных параметров, если
arg0
это числовое значение.Объект DateTimeFormatInfo , предоставляющий сведения о форматировании, зависящие от языка и региональных параметров, если
arg0
это значение даты и времени.Пользовательская IFormatProvider реализация, предоставляющая сведения о форматировании.
arg0
Как правило, такая реализация также реализует ICustomFormatter интерфейс.
Если параметр provider
имеет значение null
, сведения о форматировании получаются из текущего языка и региональных параметров.
arg0
представляет объект для форматирования. Каждый элемент format
формата заменяется строковым представлением arg0
. Если элемент форматирования включает formatString
и arg0
реализует IFormattable интерфейс, то arg0.ToString(formatString, provider)
определяет форматирование. arg0.ToString()
В противном случае определяет форматирование.
Примечания для тех, кто вызывает этот метод
В .NET Core и в платформа .NET Framework 4.0 и более поздних версиях при создании экземпляра StringBuilder объекта путем вызова StringBuilder(Int32, Int32) конструктора длина и емкость экземпляра StringBuilder могут превысить значение его MaxCapacity свойства. Это может произойти, особенно при вызове Append(String) и AppendFormat(String, Object) методах для добавления небольших строк.
См. также раздел
- Типы форматирования в .NET
- Составное форматирование
- Практическое руководство. Определение и использование поставщиков настраиваемых числовых форматов
- Строки стандартных числовых форматов
- Строки настраиваемых числовых форматов
- Строки стандартных форматов даты и времени
- Строки настраиваемых форматов даты и времени
- Строки стандартного формата TimeSpan
- Строки пользовательского формата TimeSpan
- Строки форматов перечисления
Применяется к
AppendFormat(IFormatProvider, String, Object[])
Добавляет к данному экземпляру строку, возвращаемую в результате обработки строки составного формата, содержащей ноль или более элементов формата. Каждый элемент формата заменяется строковым представлением соответствующего аргумента в массиве параметров с помощью указанного поставщика формата.
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[]
Массив объектов для форматирования.
Возвращаемое значение
Ссылка на этот экземпляр после завершения операции добавления. После операции добавления этот экземпляр содержит все данные, существовавшие до операции, к которым добавляется копия параметра format
, где все спецификации форматирования заменяются представлением строки соответствующего аргумента объекта.
Исключения
format
имеет значение null
.
format
недопустим.
-или-
Индекс элемента формата меньше нуля или больше либо равен длине массива 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
, которая форматирует 10-значный номер клиента с дефисами после четвертой и седьмой цифр. Он передается методу 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 объект.
Параметр format
состоит из нуля или нескольких выполнений текста, пересекающихся с нуля или несколькими индексируемыми заполнителями, называемыми элементами форматирования, которые соответствуют объектам в списке параметров этого метода. Процесс форматирования заменяет каждый элемент форматирования строковым представлением соответствующего объекта.
Синтаксис элемента форматирования выглядит следующим образом:
{index[,length][:formatString]}
Элементы в квадратных скобках являются необязательными. Каждый из элементов описан в таблице ниже.
Элемент | Описание |
---|---|
index | Отсчитываемая от нуля позиция в списке параметров объекта для форматирования. Если объект, заданный индексомnull , заменяется элементом String.Emptyформатирования. Если в позиции индекса нет параметра, создается исключение FormatException . |
,length | Минимальное число символов в строковом представлении параметра. Если положительный результат, параметр выравнивается по правому краю; Если отрицательный, он выравнивается по левому краю. |
:formatString | Строка стандартного или настраиваемого формата, поддерживаемая параметром. |
Примечание
Строки стандартного и настраиваемого формата, используемые со значениями даты и времени, см. в разделе "Стандартные строки формата даты и времени ", а также строки настраиваемого формата даты и времени. Строки стандартного и настраиваемого формата, используемые с числовыми значениями, см. в разделе " Строки стандартного числового формата " и "Строки настраиваемого числового формата". Строки стандартного формата, используемые с перечислениями, см. в разделе "Строки формата перечисления".
Параметр provider
задает реализацию IFormatProvider , которая может предоставлять сведения о форматировании для объектов в args
. Параметр provider
может иметь любое из следующих значений.
Объект CultureInfo , предоставляющий сведения о форматировании, зависящие от языка и региональных параметров.
NumberFormatInfo Объект, предоставляющий сведения о форматировании, зависящие от языка и региональных параметров, для числовых значений в
args
.Объект DateTimeFormatInfo , предоставляющий сведения о форматировании, зависящие от языка и региональных параметров, для значений даты и времени в
args
.Пользовательская IFormatProvider реализация, которая предоставляет сведения о форматировании для одного или нескольких объектов в
args
. Как правило, такая реализация также реализует ICustomFormatter интерфейс. Второй пример в следующем разделе иллюстрирует StringBuilder.AppendFormat(IFormatProvider, String, Object[]) вызов метода с пользовательской IFormatProvider реализацией.
Если параметр имеет значениеnull
, сведения о поставщике provider
форматирования получаются из текущего языка и региональных параметров.
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) методах для добавления небольших строк.
См. также раздел
- Типы форматирования в .NET
- Составное форматирование
- Практическое руководство. Определение и использование поставщиков настраиваемых числовых форматов
- Строки стандартных числовых форматов
- Строки настраиваемых числовых форматов
- Строки стандартных форматов даты и времени
- Строки настраиваемых форматов даты и времени
- Строки стандартного формата TimeSpan
- Строки пользовательского формата TimeSpan
- Строки форматов перечисления
Применяется к
AppendFormat(String, Object, Object)
Добавляет к данному экземпляру строку, возвращаемую в результате обработки строки составного формата, содержащей ноль или более элементов формата. Каждый элемент формата заменяется строковым представлением любого из двух аргументов.
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
Первый объект для форматирования.
- arg1
- Object
Второй объект для форматирования.
Возвращаемое значение
Ссылка на данный экземпляр с добавленным format
. Каждый элемент формата в параметре format
заменяется строковым представлением соответствующего аргумента объекта.
Исключения
format
имеет значение null
.
format
недопустим.
-или-
Индекс элемента формата меньше нуля или больше либо равен двум.
Длина развернутой строки превысила бы 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
состоит из нуля или нескольких выполнений текста, чередующихся с нуля или несколькими индексируемыми заполнителями, называемыми элементами форматирования, которые соответствуют arg0
двум arg1
объектам в списке параметров этого метода. Процесс форматирования заменяет каждый элемент форматирования строковым представлением соответствующего объекта.
Синтаксис элемента форматирования выглядит следующим образом:
{index[,length][:formatString]}
Элементы в квадратных скобках являются необязательными. Каждый из элементов описан в таблице ниже.
Элемент | Описание |
---|---|
index | Отсчитываемая от нуля позиция в списке параметров объекта для форматирования. Если объект, заданный индексомnull , заменяется элементом String.Emptyформатирования. Если в позиции индекса нет параметра, создается исключение FormatException . |
,length | Минимальное число символов в строковом представлении параметра. Если положительный результат, параметр выравнивается по правому краю; Если отрицательный, он выравнивается по левому краю. |
:formatString | Строка стандартного или настраиваемого формата, поддерживаемая параметром. |
Примечание
Строки стандартного и настраиваемого формата, используемые со значениями даты и времени, см. в разделе "Стандартные строки формата даты и времени ", а также строки настраиваемого формата даты и времени. Строки стандартного и настраиваемого формата, используемые с числовыми значениями, см. в разделе " Строки стандартного числового формата " и "Строки настраиваемого числового формата". Строки стандартного формата, используемые с перечислениями, см. в разделе "Строки формата перечисления".
arg0
и arg1
представляет объекты для форматирования. Каждый элемент format
формата заменяется строковым представлением либо arg0
arg1
. Если элемент формата включает formatString
и соответствующий объект реализует IFormattable интерфейс, тоarg
x .ToString(formatString, provider)
определяет форматирование, где x — индекс аргумента. arg
В противном случае x.ToString()
определяет форматирование.
Если строка назначена format
: "Спасибо за ваше пожертвование {0:####} продуктов питания в нашу благотворительную организацию". и arg0
является целым числом со значением 10, возвращаемое значение будет "Спасибо за ваше пожертвование 10 канит продовольствия нашей благотворительной организации".
Примечания для тех, кто вызывает этот метод
В .NET Core и в платформа .NET Framework 4.0 и более поздних версиях при создании экземпляра StringBuilder объекта путем вызова StringBuilder(Int32, Int32) конструктора длина и емкость экземпляра StringBuilder могут превысить значение его MaxCapacity свойства. Это может произойти, особенно при вызове Append(String) и AppendFormat(String, Object) методах для добавления небольших строк.
См. также раздел
- Типы форматирования в .NET
- Составное форматирование
- Строки стандартных числовых форматов
- Строки настраиваемых числовых форматов
- Строки стандартных форматов даты и времени
- Строки настраиваемых форматов даты и времени
- Строки стандартного формата TimeSpan
- Строки пользовательского формата TimeSpan
- Строки форматов перечисления
Применяется к
AppendFormat(IFormatProvider, String, Object, Object)
Добавляет к данному экземпляру строку, возвращаемую в результате обработки строки составного формата, содержащей ноль или более элементов формата. Каждый элемент формата заменяется строковым представлением любого из двух аргументов с помощью указанного поставщика формата.
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
Первый объект для форматирования.
- arg1
- Object
Второй объект для форматирования.
Возвращаемое значение
Ссылка на этот экземпляр после завершения операции добавления. После операции добавления этот экземпляр содержит все данные, существовавшие до операции, к которым добавляется копия параметра format
, где все спецификации форматирования заменяются представлением строки соответствующего аргумента объекта.
Исключения
format
имеет значение null
.
format
недопустим.
-или-
Индекс элемента формата меньше нуля или больше либо равен двум.
Длина развернутой строки превысила бы MaxCapacity.
Примеры
В следующем примере метод используется AppendFormat(IFormatProvider, String, Object, Object) для отображения данных времени и температуры, хранящихся в универсальном Dictionary<TKey,TValue> объекте. Обратите внимание, что строка форматирования имеет три элемента форматирования, хотя для форматирования используются только объекты. Это связано с тем, что первый объект в списке (значение даты и времени) используется двумя элементами формата: первый элемент формата отображает время, а второй — дату.
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 объект.
Параметр format
состоит из нуля или нескольких выполнений текста, пересекающихся с нуля или несколькими индексируемыми заполнителями, называемыми элементами форматирования, которые соответствуют объектам в списке параметров этого метода. Процесс форматирования заменяет каждый элемент форматирования строковым представлением соответствующего объекта.
Синтаксис элемента форматирования выглядит следующим образом:
{index[,length][:formatString]}
Элементы в квадратных скобках являются необязательными. Каждый из элементов описан в таблице ниже.
Элемент | Описание |
---|---|
index | Отсчитываемая от нуля позиция в списке параметров объекта для форматирования. Если объект, заданный индексомnull , заменяется элементом String.Emptyформатирования. Если в позиции индекса нет параметра, создается исключение FormatException . |
,length | Минимальное число символов в строковом представлении параметра. Если положительный результат, параметр выравнивается по правому краю; Если отрицательный, он выравнивается по левому краю. |
:formatString | Строка стандартного или настраиваемого формата, поддерживаемая параметром. |
Примечание
Строки стандартного и настраиваемого формата, используемые со значениями даты и времени, см. в разделе "Стандартные строки формата даты и времени ", а также строки настраиваемого формата даты и времени. Строки стандартного и настраиваемого формата, используемые с числовыми значениями, см. в разделе " Строки стандартного числового формата " и "Строки настраиваемого числового формата". Строки стандартного формата, используемые с перечислениями, см. в разделе "Строки формата перечисления".
Параметр provider
задает реализацию IFormatProvider , которая может предоставлять сведения о форматировании и arg0
arg1
. Параметр provider
может иметь любое из следующих значений.
Объект CultureInfo , предоставляющий сведения о форматировании, зависящие от языка и региональных параметров.
Объект NumberFormatInfo , предоставляющий сведения о форматировании, зависящие от языка и региональных параметров, или
arg0
arg1
если они являются числовыми значениями.Объект DateTimeFormatInfo , предоставляющий сведения о форматировании, зависящие от языка и региональных параметров, или
arg0
arg1
если они являются значениями даты и времени.Пользовательская IFormatProvider реализация, которая предоставляет сведения о форматировании и
arg0
arg1
. Как правило, такая реализация также реализует ICustomFormatter интерфейс.
Если параметр имеет значениеnull
, сведения о поставщике provider
форматирования получаются из текущего языка и региональных параметров.
arg0
и arg1
представляет объекты для форматирования. Каждый элемент 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) методах для добавления небольших строк.
См. также раздел
- Типы форматирования в .NET
- Составное форматирование
- Практическое руководство. Определение и использование поставщиков настраиваемых числовых форматов
- Строки стандартных числовых форматов
- Строки настраиваемых числовых форматов
- Строки стандартных форматов даты и времени
- Строки настраиваемых форматов даты и времени
- Строки стандартного формата TimeSpan
- Строки пользовательского формата TimeSpan
- Строки форматов перечисления
Применяется к
AppendFormat(String, Object, Object, Object)
Добавляет к данному экземпляру строку, возвращаемую в результате обработки строки составного формата, содержащей ноль или более элементов формата. Каждый элемент формата заменяется строковым представлением любого из трех аргументов.
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
Первый объект для форматирования.
- arg1
- Object
Второй объект для форматирования.
- arg2
- Object
Третий объект для форматирования.
Возвращаемое значение
Ссылка на данный экземпляр с добавленным format
. Каждый элемент формата в параметре format
заменяется строковым представлением соответствующего аргумента объекта.
Исключения
format
имеет значение null
.
format
недопустим.
-или-
Индекс элемента формата меньше нуля либо больше или равен 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
состоит из нуля или нескольких выполнений текста, пересекающихся с нуля или несколькими индексируемыми заполнителями, называемыми элементами форматирования, которые соответствуют arg0
arg2
объектам в списке параметров этого метода. Процесс форматирования заменяет каждый элемент форматирования строковым представлением соответствующего объекта.
Синтаксис элемента форматирования выглядит следующим образом:
{index[,length][:formatString]}
Элементы в квадратных скобках являются необязательными. Каждый из элементов описан в таблице ниже.
Элемент | Описание |
---|---|
index | Отсчитываемая от нуля позиция в списке параметров объекта для форматирования. Если объект, заданный индексомnull , заменяется элементом String.Emptyформатирования. Если в позиции индекса нет параметра, создается исключение FormatException . |
,length | Минимальное число символов в строковом представлении параметра. Если положительный результат, параметр выравнивается по правому краю; Если отрицательный, он выравнивается по левому краю. |
:formatString | Строка стандартного или настраиваемого формата, поддерживаемая параметром. |
Примечание
Строки стандартного и настраиваемого формата, используемые со значениями даты и времени, см. в разделе "Стандартные строки формата даты и времени ", а также строки настраиваемого формата даты и времени. Строки стандартного и настраиваемого формата, используемые с числовыми значениями, см. в разделе " Строки стандартного числового формата " и "Строки настраиваемого числового формата". Строки стандартного формата, используемые с перечислениями, см. в разделе "Строки формата перечисления".
arg0
, arg1
и arg2
представляют объекты для форматирования. Каждый элемент format
формата заменяется строковым представлением arg0``arg1
элемента формата или arg2
в зависимости от индекса элемента форматирования. Если элемент форматирования включает formatString
и соответствующий объект в args
реализации IFormattable интерфейса, тоarg
x .ToString(formatString, null)
определяет форматирование, где x — индекс аргумента. arg
В противном случае x.ToString()
определяет форматирование.
Если строка назначена format
: "Спасибо за ваше пожертвование {0:####} продуктов питания в нашу благотворительную организацию". и arg0
является целым числом со значением 10, возвращаемое значение будет "Спасибо за ваше пожертвование 10 канит продовольствия нашей благотворительной организации".
Примечания для тех, кто вызывает этот метод
В .NET Core и в платформа .NET Framework 4.0 и более поздних версиях при создании экземпляра StringBuilder объекта путем вызова StringBuilder(Int32, Int32) конструктора длина и емкость экземпляра StringBuilder могут превысить значение его MaxCapacity свойства. Это может произойти, особенно при вызове Append(String) и AppendFormat(String, Object) методах для добавления небольших строк.
См. также раздел
- Типы форматирования в .NET
- Составное форматирование
- Строки стандартных числовых форматов
- Строки настраиваемых числовых форматов
- Строки стандартных форматов даты и времени
- Строки настраиваемых форматов даты и времени
- Строки стандартного формата TimeSpan
- Строки пользовательского формата TimeSpan
- Строки форматов перечисления