String.Format Метод

Ссылка

Определение

Пространство имен:: System

Сборка:: System.Runtime.dll

Сборка:: mscorlib.dll

Сборка:: netstandard.dll

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Преобразует значения объектов в строки на основе указанных форматов и вставляет их в другую строку.

Если вы не знакомы с этим методом String.Format , ознакомьтесь с кратким обзором в статье Начало работы с методом String.Format .

Перегрузки

Format(IFormatProvider, String, Object, Object, Object)	Заменяет элементы формата в строке строковым представлением трех указанных объектов. Параметр предоставляет сведения об особенностях форматирования, связанных с языком и региональными параметрами.
Format(String, Object, Object, Object)	Заменяет элементы формата в строке строковым представлением трех указанных объектов.
Format(IFormatProvider, String, Object, Object)	Заменяет элементы формата в строке строковым представлением двух указанных объектов. Параметр предоставляет сведения об особенностях форматирования, связанных с языком и региональными параметрами.
Format(String, Object, Object)	Заменяет элементы формата в строке строковым представлением двух указанных объектов.
Format(IFormatProvider, CompositeFormat, ReadOnlySpan<Object>)	Заменяет элемент или элементы формата в на CompositeFormat строковое представление соответствующих объектов в указанном формате.
Format(IFormatProvider, String, Object)	Заменяет элементы формата в указанной строке строковым представлением соответствующего объекта. Параметр предоставляет сведения об особенностях форматирования, связанных с языком и региональными параметрами.
Format(IFormatProvider, String, Object[])	Заменяет элементы формата в строке строковым представлениями соответствующих объектов в указанном массиве. Параметр предоставляет сведения об особенностях форматирования, связанных с языком и региональными параметрами.
Format(String, Object[])	Заменяет элемент формата в указанной строке строковым представлением соответствующего объекта в указанном массиве.
Format(String, Object)	Заменяет один или более элементов формата в строке строковым представлением указанного объекта.
Format(IFormatProvider, CompositeFormat, Object[])	Заменяет элемент или элементы формата в на CompositeFormat строковое представление соответствующих объектов в указанном формате.
Format<TArg0,TArg1,TArg2>(IFormatProvider, CompositeFormat, TArg0, TArg1, TArg2)	Заменяет элемент или элементы формата в на CompositeFormat строковое представление соответствующих объектов в указанном формате.
Format<TArg0,TArg1>(IFormatProvider, CompositeFormat, TArg0, TArg1)	Заменяет элемент или элементы формата в на CompositeFormat строковое представление соответствующих объектов в указанном формате.
Format<TArg0>(IFormatProvider, CompositeFormat, TArg0)	Заменяет элемент или элементы формата в на CompositeFormat строковое представление соответствующих объектов в указанном формате.

Format(IFormatProvider, String, Object, Object, Object)

Исходный код:: String.Manipulation.cs

Исходный код:: String.Manipulation.cs

Исходный код:: String.Manipulation.cs

Заменяет элементы формата в строке строковым представлением трех указанных объектов. Параметр предоставляет сведения об особенностях форматирования, связанных с языком и региональными параметрами.

public:
 static System::String ^ Format(IFormatProvider ^ provider, System::String ^ format, System::Object ^ arg0, System::Object ^ arg1, System::Object ^ arg2);

public static string Format (IFormatProvider provider, string format, object arg0, object arg1, object arg2);

public static string Format (IFormatProvider? provider, string format, object? arg0, object? arg1, object? arg2);

static member Format : IFormatProvider * string * obj * obj * obj -> string

Public Shared Function Format (provider As IFormatProvider, format As String, arg0 As Object, arg1 As Object, arg2 As Object) As String

Параметры

provider: IFormatProvider

Объект, предоставляющий сведения о форматировании для определенного языка и региональных параметров.

format: String

Строка составного форматирования.

arg0: Object

Первый объект для форматирования.

arg1: Object

Второй объект для форматирования.

arg2: Object

Третий объект для форматирования.

Возвращаемое значение

String

Копия format, в которой все элементы формата заменены строковыми представлениями arg0, arg1 и arg2.

Исключения

ArgumentNullException

format имеет значение null.

FormatException

format недопустим.

-или-

Индекс элемента формата меньше нуля или больше двух.

Вместо вызова метода String.Format или использования строк составного формата можно использовать интерполированные строки, если ваш язык их поддерживает. Интерполированная строка — это строка, которая содержит интерполированные выражения. Каждое интерполированное выражение завершается значением выражения и включается в строку результатов, если строка назначена. Дополнительные сведения см. в разделе Интерполяция строк (справочник по C#) и Интерполированные строки (справочник по Visual Basic).

Этот метод использует функцию составного форматирования для преобразования трех выражений в их строковые представления и внедрения этих представлений в строку. При выполнении преобразования метод использует форматирование с учетом языка и региональных параметров или пользовательский модуль форматирования. Метод преобразует каждый Object аргумент в строковое представление путем вызова метода ToString(IFormatProvider) или, если соответствующий элемент формата объекта включает строку формата, путем вызова его метода ToString(String,IFormatProvider). Если эти методы не существуют, он вызывает метод ToString объекта без параметров.

Однако при вызове String.Format метода нет необходимости сосредоточиться на конкретной перегрузке, которую требуется вызвать. Вместо этого можно вызвать этот метод с использованием объекта, который предоставляет зависящее от языка и региональных параметров или настраиваемое форматирование, а также составной строки формата, которая включает один или несколько элементов формата. Каждому элементу формата назначается числовой индекс, начиная с 0. Помимо исходной строки вызов метода должен содержать дополнительные аргументы, число которых соответствует количеству значений индекса. Например, строка, элементы формата которой имеют индексы 0 и 1, должна иметь 2 аргумента. Для строки с индексами от 0 до 5 потребуется 6 аргументов. Затем компилятор языка разрешим вызов метода в определенную перегрузку String.Format метода.

Более подробную документацию по использованию метода см. в статьях String.FormatНачало работы с методом String.Format и Какой метод вызывается?.

Применяется к

Format(String, Object, Object, Object)

Исходный код:: String.Manipulation.cs

Исходный код:: String.Manipulation.cs

Исходный код:: String.Manipulation.cs

Заменяет элементы формата в строке строковым представлением трех указанных объектов.

public:
 static System::String ^ Format(System::String ^ format, System::Object ^ arg0, System::Object ^ arg1, System::Object ^ arg2);

public static string Format (string format, object arg0, object arg1, object arg2);

public static string Format (string format, object? arg0, object? arg1, object? arg2);

static member Format : string * obj * obj * obj -> string

Public Shared Function Format (format As String, arg0 As Object, arg1 As Object, arg2 As Object) As String

Параметры

format: String

Строка составного форматирования.

arg0: Object

Первый объект для форматирования.

arg1: Object

Второй объект для форматирования.

arg2: Object

Третий объект для форматирования.

Возвращаемое значение

String

Копия format, в которой все элементы формата заменены строковыми представлениями arg0, arg1 и arg2.

Исключения

ArgumentNullException

format имеет значение null.

FormatException

format недопустим.

-или-

Индекс элемента формата меньше нуля или больше двух.

Этот метод использует функцию составного форматирования для преобразования значения трех выражений в их строковые представления и внедрения этих представлений в строку.

Однако при вызове String.Format метода нет необходимости сосредоточиться на конкретной перегрузке, которую требуется вызвать. Вместо этого можно вызвать метод с составной строкой формата, которая включает один или несколько элементов формата. Каждому элементу формата назначается числовой индекс, начиная с 0. Помимо исходной строки вызов метода должен содержать дополнительные аргументы, число которых соответствует количеству значений индекса. Например, строка, элементы формата которой имеют индексы 0 и 1, должна иметь 2 аргумента. Для строки с индексами от 0 до 5 потребуется 6 аргументов. Затем компилятор языка разрешим вызов метода в определенную перегрузку String.Format метода.

Пример: форматирование трех аргументов

В этом примере метод используется Format(String, Object, Object, Object) для создания строки, которая иллюстрирует результат логической And операции с двумя целочисленными значениями. Обратите внимание, что строка форматирования включает шесть элементов форматирования, но метод содержит только три элемента в списке параметров, так как каждый элемент форматируется двумя различными способами.

using namespace System;

void main()
{
   String^ formatString = "    {0,10} ({0,8:X8})\n" + 
                           "And {1,10} ({1,8:X8})\n" + 
                           "  = {2,10} ({2,8:X8})";
   int value1 = 16932;
   int value2 = 15421;
   String^ result = String::Format(formatString, 
                                   value1, value2, value1 & value2);
   Console::WriteLine(result);
}
// The example displays the following output:
//                16932 (00004224)
//       And      15421 (00003C3D)
//         =         36 (00000024)

string formatString = "    {0,10} ({0,8:X8})\n" + 
                      "And {1,10} ({1,8:X8})\n" + 
                      "  = {2,10} ({2,8:X8})";
int value1 = 16932;
int value2 = 15421;
string result = String.Format(formatString, 
                              value1, value2, value1 & value2);
Console.WriteLine(result);
// The example displays the following output:
//                16932 (00004224)
//       And      15421 (00003C3D)
//         =         36 (00000024)

open System

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

let value1 = 16932
let value2 = 15421
String.Format(formatString, value1, value2, value1 &&& value2)
|> printfn "%s"
// The example displays the following output:
//                16932 (00004224)
//       And      15421 (00003C3D)
//         =         36 (00000024)

Public Module Example
   Public Sub Main()
      Dim formatString As String = "    {0,10} ({0,8:X8})" + vbCrLf +  _
                                   "And {1,10} ({1,8:X8})" + vbCrLf + _
                                   "  = {2,10} ({2,8:X8})"
      Dim value1 As Integer = 16932
      Dim value2 As Integer = 15421
      Dim result As String = String.Format(formatString, _
                                           value1, value2, value1 And value2)
      Console.WriteLine(result)                          
   End Sub
End Module
' The example displays the following output:
'                16932 (00004224)
'       And      15421 (00003C3D)
'         =         36 (00000024)

См. также раздел

Применяется к

Format(IFormatProvider, String, Object, Object)

Исходный код:: String.Manipulation.cs

Исходный код:: String.Manipulation.cs

Исходный код:: String.Manipulation.cs

Заменяет элементы формата в строке строковым представлением двух указанных объектов. Параметр предоставляет сведения об особенностях форматирования, связанных с языком и региональными параметрами.

public:
 static System::String ^ Format(IFormatProvider ^ provider, System::String ^ format, System::Object ^ arg0, System::Object ^ arg1);

public static string Format (IFormatProvider provider, string format, object arg0, object arg1);

public static string Format (IFormatProvider? provider, string format, object? arg0, object? arg1);

static member Format : IFormatProvider * string * obj * obj -> string

Public Shared Function Format (provider As IFormatProvider, format As String, arg0 As Object, arg1 As Object) As String

Параметры

provider: IFormatProvider

Объект, предоставляющий сведения о форматировании для определенного языка и региональных параметров.

format: String

Строка составного форматирования.

arg0: Object

Первый объект для форматирования.

arg1: Object

Второй объект для форматирования.

Возвращаемое значение

String

Копия format, в которой все элементы формата заменены строковыми представлениями arg0 и arg1.

Исключения

ArgumentNullException

format имеет значение null.

FormatException

format недопустим.

-или-

Индекс элемента формата не равен нулю или единице.

Этот метод использует функцию составного форматирования для преобразования двух выражений в строковые представления и внедрения этих представлений в строку. При выполнении преобразования метод использует форматирование с учетом языка и региональных параметров или пользовательский модуль форматирования. Метод преобразует каждый Object аргумент в строковое представление путем вызова метода ToString(IFormatProvider) или, если соответствующий элемент формата объекта включает строку формата, путем вызова его метода ToString(String,IFormatProvider). Если эти методы не существуют, он вызывает метод ToString объекта без параметров.

Применяется к

Format(String, Object, Object)

Исходный код:: String.Manipulation.cs

Исходный код:: String.Manipulation.cs

Исходный код:: String.Manipulation.cs

Заменяет элементы формата в строке строковым представлением двух указанных объектов.

public:
 static System::String ^ Format(System::String ^ format, System::Object ^ arg0, System::Object ^ arg1);

public static string Format (string format, object arg0, object arg1);

public static string Format (string format, object? arg0, object? arg1);

static member Format : string * obj * obj -> string

Public Shared Function Format (format As String, arg0 As Object, arg1 As Object) As String

Параметры

format: String

Строка составного форматирования.

arg0: Object

Первый объект для форматирования.

arg1: Object

Второй объект для форматирования.

Возвращаемое значение

String

Копия format, в которой все элементы формата заменены строковыми представлениями arg0 и arg1.

Исключения

ArgumentNullException

format имеет значение null.

FormatException

format недопустим.

-или-

Индекс элемента формата не равен нулю или единице.

Этот метод использует функцию составного форматирования для преобразования значения двух выражений в их строковые представления и для внедрения этих представлений в строку.

Пример. Форматирование двух аргументов

В этом примере метод используется Format(String, Object, Object) для отображения данных о времени и температуре, хранящихся в универсальном Dictionary<TKey,TValue> объекте . Обратите внимание, что строка форматирования содержит три элемента форматирования, хотя есть только два объекта для форматирования. Это связано с тем, что первый объект в списке (значение даты и времени) используется двумя элементами формата: первый элемент формата отображает время, а второй — дату.

using namespace System;
using namespace System::Collections::Generic;

void main()
{
   Dictionary<DateTime, Double>^ temperatureInfo = gcnew Dictionary<DateTime, Double>(); 
   temperatureInfo->Add(DateTime(2010, 6, 1, 14, 0, 0), 87.46);
   temperatureInfo->Add(DateTime(2010, 12, 1, 10, 0, 0), 36.81);
      
   Console::WriteLine("Temperature Information:\n");
   String^ output;   
   for each (KeyValuePair<DateTime, Double>^ item in temperatureInfo)
   {
      output = String::Format("Temperature at {0,8:t} on {0,9:d}: {1,5:N1}�F", 
                              item->Key, item->Value);
      Console::WriteLine(output);
   }
}
// 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

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

Console.WriteLine("Temperature Information:\n");
string output;   
foreach (var item in temperatureInfo)
{
   output = String.Format("Temperature at {0,8:t} on {0,9:d}: {1,5:N1}°F", 
                          item.Key, item.Value);
   Console.WriteLine(output);
}
// The example displays output like the following:
//       Temperature Information:
//       
//       Temperature at  2:00 PM on  6/1/2010:  87.5°F
//       Temperature at 10:00 AM on 12/1/2010:  36.8°F

open System
open System.Collections.Generic

let temperatureInfo = Dictionary<DateTime, float>() 
temperatureInfo.Add(DateTime(2010, 6, 1, 14, 0, 0), 87.46)
temperatureInfo.Add(DateTime(2010, 12, 1, 10, 0, 0), 36.81)

printfn $"Temperature Information:\n"
for item in temperatureInfo do
   String.Format("Temperature at {0,8:t} on {0,9:d}: {1,5:N1}°F", item.Key, item.Value)
   |> printfn "%s"
// The example displays output like the following:
//       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

Module Example
   Public Sub Main()
      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)
      
      Console.WriteLine("Temperature Information:")
      Console.WriteLine()
      Dim output As String   
      For Each item In temperatureInfo
         output = String.Format("Temperature at {0,8:t} on {0,9:d}: {1,5:N1}°F", _
                                item.Key, item.Value)
         Console.WriteLine(output)
      Next
   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

См. также раздел

Применяется к

Format(IFormatProvider, CompositeFormat, ReadOnlySpan<Object>)

Исходный код:: String.Manipulation.cs

Исходный код:: String.Manipulation.cs

Заменяет элемент или элементы формата в на CompositeFormat строковое представление соответствующих объектов в указанном формате.

public:
 static System::String ^ Format(IFormatProvider ^ provider, System::Text::CompositeFormat ^ format, ReadOnlySpan<System::Object ^> args);

public static string Format (IFormatProvider? provider, System.Text.CompositeFormat format, ReadOnlySpan<object?> args);

static member Format : IFormatProvider * System.Text.CompositeFormat * ReadOnlySpan<obj> -> string

Public Shared Function Format (provider As IFormatProvider, format As CompositeFormat, args As ReadOnlySpan(Of Object)) As String

Параметры

provider: IFormatProvider

Объект, предоставляющий сведения о форматировании для определенного языка и региональных параметров.

format: CompositeFormat

CompositeFormat.

args: ReadOnlySpan<Object>

Диапазон объектов для форматирования.

Возвращаемое значение

String

Форматированная строка.

Исключения

ArgumentNullException

format имеет значение null.

FormatException

Индекс элемента формата больше или равен количеству предоставленных аргументов.

Применяется к

Format(IFormatProvider, String, Object)

Исходный код:: String.Manipulation.cs

Исходный код:: String.Manipulation.cs

Исходный код:: String.Manipulation.cs

Заменяет элементы формата в указанной строке строковым представлением соответствующего объекта. Параметр предоставляет сведения об особенностях форматирования, связанных с языком и региональными параметрами.

public:
 static System::String ^ Format(IFormatProvider ^ provider, System::String ^ format, System::Object ^ arg0);

public static string Format (IFormatProvider provider, string format, object arg0);

public static string Format (IFormatProvider? provider, string format, object? arg0);

static member Format : IFormatProvider * string * obj -> string

Public Shared Function Format (provider As IFormatProvider, format As String, arg0 As Object) As String

Параметры

provider: IFormatProvider

Объект, предоставляющий сведения о форматировании для определенного языка и региональных параметров.

format: String

Строка составного форматирования.

arg0: Object

Объект для форматирования.

Возвращаемое значение

String

Копия format, в которой элементы форматирования были заменены строковым представлением arg0.

Исключения

ArgumentNullException

format имеет значение null.

FormatException

format недопустим.

-или-

Индекс элемента формата не равен нулю.

Этот метод использует функцию составного форматирования для преобразования значения выражения в строковое представление и для внедрения этого представления в строку. При выполнении преобразования метод использует форматирование с учетом языка и региональных параметров или пользовательский модуль форматирования. Метод преобразуется в строковое arg0 представление путем вызова метода ToString(IFormatProvider) или, если соответствующий элемент форматирования объекта включает строку формата, путем вызова метода ToString(String,IFormatProvider). Если эти методы не существуют, он вызывает метод ToString объекта без параметров.

Применяется к

Format(IFormatProvider, String, Object[])

Исходный код:: String.Manipulation.cs

Исходный код:: String.Manipulation.cs

Исходный код:: String.Manipulation.cs

Заменяет элементы формата в строке строковым представлениями соответствующих объектов в указанном массиве. Параметр предоставляет сведения об особенностях форматирования, связанных с языком и региональными параметрами.

public:
 static System::String ^ Format(IFormatProvider ^ provider, System::String ^ format, ... cli::array <System::Object ^> ^ args);

public static string Format (IFormatProvider provider, string format, params object[] args);

public static string Format (IFormatProvider? provider, string format, params object?[] args);

static member Format : IFormatProvider * string * obj[] -> string

Public Shared Function Format (provider As IFormatProvider, format As String, ParamArray args As Object()) As String

Параметры

provider: IFormatProvider

Объект, предоставляющий сведения о форматировании для определенного языка и региональных параметров.

format: String

Строка составного форматирования.

args: Object[]

Массив объектов, содержащий нуль или более форматируемых объектов.

Возвращаемое значение

String

Копия format, в которой элементы формата заменены строковыми представления соответствующих объектов в args.

Исключения

ArgumentNullException

Параметр format или args имеет значение null.

FormatException

format недопустим.

-или-

Индекс элемента формата меньше нуля или больше либо равен длине массива args.

Этот метод использует функцию составного форматирования для преобразования четырех или более выражений в их строковые представления и для внедрения этих представлений в строку. При выполнении преобразования метод использует форматирование с учетом языка и региональных параметров или пользовательский модуль форматирования. Метод преобразует каждый Object аргумент в строковое представление путем вызова метода ToString(IFormatProvider) или, если соответствующий элемент формата объекта включает строку формата, путем вызова его метода ToString(String,IFormatProvider). Если эти методы не существуют, он вызывает метод ToString объекта без параметров.

Пример. Форматирование с учетом языка и региональных параметров

В этом примере метод используется Format(IFormatProvider, String, Object[]) для отображения строкового представления некоторых значений даты и времени и числовых значений с использованием нескольких разных языков и региональных параметров.

string[] cultureNames = { "en-US", "fr-FR", "de-DE", "es-ES" };

DateTime dateToDisplay = new DateTime(2009, 9, 1, 18, 32, 0);
double value = 9164.32;

Console.WriteLine("Culture     Date                                Value\n");
foreach (string cultureName in cultureNames)
{
   System.Globalization.CultureInfo culture = new System.Globalization.CultureInfo(cultureName);
   string output = String.Format(culture, "{0,-11} {1,-35:D} {2:N}", 
                                 culture.Name, dateToDisplay, value);
   Console.WriteLine(output);
}    
// The example displays the following output:
//    Culture     Date                                Value
//    
//    en-US       Tuesday, September 01, 2009         9,164.32
//    fr-FR       mardi 1 septembre 2009              9 164,32
//    de-DE       Dienstag, 1. September 2009         9.164,32
//    es-ES       martes, 01 de septiembre de 2009    9.164,32

open System
open System.Globalization

let cultureNames = [| "en-US"; "fr-FR"; "de-DE"; "es-ES" |]

let dateToDisplay = DateTime(2009, 9, 1, 18, 32, 0)
let value = 9164.32

printfn "Culture     Date                                Value\n"
for cultureName in cultureNames do
    let culture = CultureInfo cultureName
    String.Format(culture, "{0,-11} {1,-35:D} {2:N}", culture.Name, dateToDisplay, value)
    |> printfn "%s"
// The example displays the following output:
//    Culture     Date                                Value
//    
//    en-US       Tuesday, September 01, 2009         9,164.32
//    fr-FR       mardi 1 septembre 2009              9 164,32
//    de-DE       Dienstag, 1. September 2009         9.164,32
//    es-ES       martes, 01 de septiembre de 2009    9.164,32

Imports System.Globalization

Module Example
   Public Sub Main()
      Dim cultureNames() As String = { "en-US", "fr-FR", "de-DE", "es-ES" }
      
      Dim dateToDisplay As Date = #9/1/2009 6:32PM#
      Dim value As Double = 9164.32

      Console.WriteLine("Culture     Date                                Value")
      Console.WriteLine()      
      For Each cultureName As String In cultureNames
         Dim culture As New CultureInfo(cultureName)
         Dim output As String = String.Format(culture, "{0,-11} {1,-35:D} {2:N}", _
                                              culture.Name, dateToDisplay, value)
         Console.WriteLine(output)
      Next    
   End Sub
End Module
' The example displays the following output:
'       Culture     Date                                Value
'       
'       en-US       Tuesday, September 01, 2009         9,164.32
'       fr-FR       mardi 1 septembre 2009              9 164,32
'       de-DE       Dienstag, 1. September 2009         9.164,32
'       es-ES       martes, 01 de septiembre de 2009    9.164,32

См. также раздел

Применяется к

Format(String, Object[])

Исходный код:: String.Manipulation.cs

Исходный код:: String.Manipulation.cs

Исходный код:: String.Manipulation.cs

Заменяет элемент формата в указанной строке строковым представлением соответствующего объекта в указанном массиве.

public:
 static System::String ^ Format(System::String ^ format, ... cli::array <System::Object ^> ^ args);

public static string Format (string format, params object[] args);

public static string Format (string format, params object?[] args);

static member Format : string * obj[] -> string

Public Shared Function Format (format As String, ParamArray args As Object()) As String

Параметры

format: String

Строка составного форматирования.

args: Object[]

Массив объектов, содержащий нуль или более форматируемых объектов.

Возвращаемое значение

String

Копия format, в которой элементы формата заменены строковыми представления соответствующих объектов в args.

Исключения

ArgumentNullException

Параметр format или args имеет значение null.

FormatException

format недопустим.

-или-

Индекс элемента формата меньше нуля или больше либо равен длине массива args.

Этот метод использует функцию составного форматирования для преобразования значения четырех или более выражений в их строковые представления и для внедрения этих представлений в строку. args Так как параметр помечен атрибутом System.ParamArrayAttribute , объекты можно передать в метод в виде отдельных аргументов или массиваObject.

Пример: форматирование более трех аргументов

В этом примере создается строка, содержащая данные о высокой и низкой температуре на определенную дату. Строка составного формата содержит пять элементов форматирования в примере C# и шесть в примере Visual Basic. Два элемента формата определяют ширину строкового представления соответствующего значения, а первый элемент форматирования также включает стандартную строку формата даты и времени.

using namespace System;

void main()
{
   DateTime date1 = DateTime(2009, 7, 1);
   TimeSpan hiTime = TimeSpan(14, 17, 32);
   Decimal hiTemp = (Decimal) 62.1; 
   TimeSpan loTime = TimeSpan(3, 16, 10);
   Decimal loTemp = (Decimal)54.8; 

   String^ result1 = String::Format("Temperature on {0:d}:\n{1,11}: {2} degrees (hi)\n{3,11}: {4} degrees (lo)", 
                                    date1, hiTime, hiTemp, loTime, loTemp);
   Console::WriteLine(result1);
   Console::WriteLine();
           
   String^ result2 = String::Format("Temperature on {0:d}:\n{1,11}: {2} degrees (hi)\n{3,11}: {4} degrees (lo)", 
                                    gcnew array<Object^> { date1, hiTime, hiTemp, loTime, loTemp });
   Console::WriteLine(result2);
}
// The example displays the following output:
//       Temperature on 7/1/2009:
//          14:17:32: 62.1 degrees (hi)
//          03:16:10: 54.8 degrees (lo)
//       Temperature on 7/1/2009:
//          14:17:32: 62.1 degrees (hi)
//          03:16:10: 54.8 degrees (lo)

DateTime date1 = new DateTime(2009, 7, 1);
TimeSpan hiTime = new TimeSpan(14, 17, 32);
decimal hiTemp = 62.1m; 
TimeSpan loTime = new TimeSpan(3, 16, 10);
decimal loTemp = 54.8m; 

string result1 = String.Format("Temperature on {0:d}:\n{1,11}: {2} degrees (hi)\n{3,11}: {4} degrees (lo)", 
                               date1, hiTime, hiTemp, loTime, loTemp);
Console.WriteLine(result1);
Console.WriteLine();
     
string result2 = String.Format("Temperature on {0:d}:\n{1,11}: {2} degrees (hi)\n{3,11}: {4} degrees (lo)", 
                               new object[] { date1, hiTime, hiTemp, loTime, loTemp });
Console.WriteLine(result2);
// The example displays output like the following:
//       Temperature on 7/1/2009:
//          14:17:32: 62.1 degrees (hi)
//          03:16:10: 54.8 degrees (lo)
//       Temperature on 7/1/2009:
//          14:17:32: 62.1 degrees (hi)
//          03:16:10: 54.8 degrees (lo)

let date1 = DateTime(2009, 7, 1)
let hiTime = TimeSpan(14, 17, 32)
let hiTemp = 62.1m 
let loTime = TimeSpan(3, 16, 10)
let loTemp = 54.8m 

String.Format("Temperature on {0:d}:\n{1,11}: {2} degrees (hi)\n{3,11}: {4} degrees (lo)", date1, hiTime, hiTemp, loTime, loTemp)
|> printfn "%s\n"
      
String.Format("Temperature on {0:d}:\n{1,11}: {2} degrees (hi)\n{3,11}: {4} degrees (lo)", [| date1 :> obj; hiTime; hiTemp; loTime; loTemp |])
|> printfn "%s"
// The example displays output like the following:
//       Temperature on 7/1/2009:
//          14:17:32: 62.1 degrees (hi)
//          03:16:10: 54.8 degrees (lo)
//       Temperature on 7/1/2009:
//          14:17:32: 62.1 degrees (hi)
//          03:16:10: 54.8 degrees (lo)

Module Example
   Public Sub Main()
      Dim date1 As Date = #7/1/2009#
      Dim hiTime As New TimeSpan(14, 17, 32)
      Dim hiTemp As Decimal = 62.1d 
      Dim loTime As New TimeSpan(3, 16, 10)
      Dim loTemp As Decimal = 54.8d 

      Dim result1 As String = String.Format("Temperature on {0:d}:{5}{1,11}: {2} degrees (hi){5}{3,11}: {4} degrees (lo)", _
                                           date1, hiTime, hiTemp, loTime, loTemp, vbCrLf)
      Console.WriteLine(result1)
      Console.WriteLine()
           
      Dim result2 As String = String.Format("Temperature on {0:d}:{5}{1,11}: {2} degrees (hi){5}{3,11}: {4} degrees (lo)", _
                                            New Object() { date1, hiTime, hiTemp, loTime, loTemp, vbCrLf })
      Console.WriteLine(result2)                                            
   End Sub
End Module
' The example displays the following output:
'       Temperature on 7/1/2009:
'          14:17:32: 62.1 degrees (hi)
'          03:16:10: 54.8 degrees (lo)
'
'       Temperature on 7/1/2009:
'          14:17:32: 62.1 degrees (hi)
'          03:16:10: 54.8 degrees (lo)

Можно также передать объекты для форматирования в виде массива, а не списка аргументов.

using namespace System;

ref class CityInfo
{
public:
   CityInfo(String^ name, int population, Decimal area, int year)
   {
      this->Name = name;
      this->Population = population;
      this->Area = area;
      this->Year = year;
   }
   
   String^ Name; 
   int Population;
   Decimal Area;
   int Year;
};

ref class Example
{
public:
   static void ShowPopulationData(CityInfo^ city)
   {
      array<Object^>^ args = gcnew array<Object^> { city->Name, city->Year, city->Population, city->Area };
      String^ result = String::Format("{0} in {1}: Population {2:N0}, Area {3:N1} sq. feet", 
                                    args);
      Console::WriteLine(result); 
   }
};

void main()
{
   CityInfo^ nyc2010 = gcnew CityInfo("New York", 8175133, (Decimal) 302.64, 2010);
   Example::ShowPopulationData(nyc2010);
   CityInfo^ sea2010 = gcnew CityInfo("Seattle", 608660, (Decimal) 83.94, 2010);      
   Example::ShowPopulationData(sea2010); 
}
// The example displays the following output:
//       New York in 2010: Population 8,175,133, Area 302.6 sq. feet
//       Seattle in 2010: Population 608,660, Area 83.9 sq. feet

using System;

public class CityInfo
{
   public CityInfo(String name, int population, Decimal area, int year)
   {
      this.Name = name;
      this.Population = population;
      this.Area = area;
      this.Year = year;
   }
   
   public readonly String Name; 
   public readonly int Population;
   public readonly Decimal Area;
   public readonly int Year;
}

public class Example
{
   public static void Main()
   {
      CityInfo nyc2010 = new CityInfo("New York", 8175133, 302.64m, 2010);
      ShowPopulationData(nyc2010);
      CityInfo sea2010 = new CityInfo("Seattle", 608660, 83.94m, 2010);      
      ShowPopulationData(sea2010); 
   }

   private static void ShowPopulationData(CityInfo city)
   {
      object[] args = { city.Name, city.Year, city.Population, city.Area };
      String result = String.Format("{0} in {1}: Population {2:N0}, Area {3:N1} sq. feet", 
                                    args);
      Console.WriteLine(result); 
   }
}
// The example displays the following output:
//       New York in 2010: Population 8,175,133, Area 302.6 sq. feet
//       Seattle in 2010: Population 608,660, Area 83.9 sq. feet

open System

type CityInfo =
  { Name: string
    Population: int
    Area: Decimal
    Year: int }

let showPopulationData city =
    let args: obj[] = [| city.Name; city.Year; city.Population; city.Area |]
    String.Format("{0} in {1}: Population {2:N0}, Area {3:N1} sq. feet", args)
    |> printfn "%s"

{ Name = "New York"; Population = 8175133; Area = 302.64m; Year = 2010 }
|> showPopulationData

 
{ Name = "Seattle"; Population = 608660; Area = 83.94m; Year = 2010 }      
|> showPopulationData 

// The example displays the following output:
//       New York in 2010: Population 8,175,133, Area 302.6 sq. feet
//       Seattle in 2010: Population 608,660, Area 83.9 sq. feet

Public Class CityInfo
   Public Sub New(name As String, population As Integer, area As Decimal, year As Integer)
      Me.Name = name
      Me.Population = population
      Me.Area = area
      Me.Year = year
   End Sub
   
   Public ReadOnly Name As String
   Public ReadOnly Population As Integer
   Public ReadOnly Area As Decimal
   Public ReadOnly Year As Integer
End Class

Module Example
   Public Sub Main()
      Dim nyc2010 As New CityInfo("New York", 8175133, 302.64d, 2010)
      ShowPopulationData(nyc2010)
      Dim sea2010 As New CityInfo("Seattle", 608660, 83.94d, 2010)      
      ShowPopulationData(sea2010) 
   End Sub
   
   Private Sub ShowPopulationData(city As CityInfo)
      Dim args() As Object = { city.Name, city.Year, city.Population, city.Area }
      Dim result = String.Format("{0} in {1}: Population {2:N0}, Area {3:N1} sq. feet", args)
      Console.WriteLine(result) 
   End Sub
End Module
' The example displays the following output:
'       New York in 2010: Population 8,175,133, Area 302.6 sq. feet
'       Seattle in 2010: Population 608,660, Area 83.9 sq. feet

См. также раздел

Применяется к

Format(String, Object)

Исходный код:: String.Manipulation.cs

Исходный код:: String.Manipulation.cs

Исходный код:: String.Manipulation.cs

Заменяет один или более элементов формата в строке строковым представлением указанного объекта.

public:
 static System::String ^ Format(System::String ^ format, System::Object ^ arg0);

public static string Format (string format, object arg0);

public static string Format (string format, object? arg0);

static member Format : string * obj -> string

Public Shared Function Format (format As String, arg0 As Object) As String

Параметры

format: String

Строка составного форматирования.

arg0: Object

Объект для форматирования.

Возвращаемое значение

String

Копия format, в которой все элементы формата заменены строковыми представлениями arg0.

Исключения

ArgumentNullException

format имеет значение null.

FormatException

Недопустимый элемент формата в format.

-или-

Индекс элемента формата не равен нулю.

Этот метод использует функцию составного форматирования для преобразования значения выражения в строковое представление и для внедрения этого представления в строку.

Пример. Форматирование одного аргумента

В следующем примере метод используется Format(String, Object) для внедрения возраста пользователя в середину строки.

using namespace System;

void main()
{
   DateTime birthdate = DateTime(1993, 7, 28);
   array<DateTime>^ dates = gcnew array<DateTime> { DateTime(1993, 8, 16), 
                                                    DateTime(1994, 7, 28), 
                                                    DateTime(2000, 10, 16), 
                                                    DateTime(2003, 7, 27), 
                                                    DateTime(2007, 5, 27) };

   for each (DateTime dateValue in dates)
   {
      TimeSpan interval = dateValue - birthdate;
      // Get the approximate number of years, without accounting for leap years.
      int years = ((int)interval.TotalDays) / 365;
      // See if adding the number of years exceeds dateValue.
      String^ output;
      if (birthdate.AddYears(years) <= dateValue) {
         output = String::Format("You are now {0} years old.", years);
         Console::WriteLine(output);
      }   
      else {
         output = String::Format("You are now {0} years old.", years - 1);
         Console::WriteLine(output);
      }      
   }
}
// The example displays the following output:
//       You are now 0 years old.
//       You are now 1 years old.
//       You are now 7 years old.
//       You are now 9 years old.
//       You are now 13 years old.

DateTime birthdate = new DateTime(1993, 7, 28);
DateTime[] dates = { new DateTime(1993, 8, 16), 
                     new DateTime(1994, 7, 28), 
                     new DateTime(2000, 10, 16), 
                     new DateTime(2003, 7, 27), 
                     new DateTime(2007, 5, 27) };

foreach (DateTime dateValue in dates)
{
   TimeSpan interval = dateValue - birthdate;
   // Get the approximate number of years, without accounting for leap years.
   int years = ((int) interval.TotalDays) / 365;
   // See if adding the number of years exceeds dateValue.
   string output;
   if (birthdate.AddYears(years) <= dateValue) {
      output = String.Format("You are now {0} years old.", years);
      Console.WriteLine(output);
   }   
   else {
      output = String.Format("You are now {0} years old.", years - 1);
      Console.WriteLine(output);
   }      
}
// The example displays the following output:
//       You are now 0 years old.
//       You are now 1 years old.
//       You are now 7 years old.
//       You are now 9 years old.
//       You are now 13 years old.

let birthdate = DateTime(1993, 7, 28)
let dates = 
    [ DateTime(1993, 8, 16) 
      DateTime(1994, 7, 28)
      DateTime(2000, 10, 16)
      DateTime(2003, 7, 27)
      DateTime(2007, 5, 27) ]

for dateValue in dates do
    let interval = dateValue - birthdate
    // Get the approximate number of years, without accounting for leap years.
    let years = (int interval.TotalDays) / 365
    // See if adding the number of years exceeds dateValue.
    if birthdate.AddYears years <= dateValue then
        String.Format("You are now {0} years old.", years)
    else
        String.Format("You are now {0} years old.", years - 1)
    |> printfn "%s"
// The example displays the following output:
//       You are now 0 years old.
//       You are now 1 years old.
//       You are now 7 years old.
//       You are now 9 years old.
//       You are now 13 years old.

Module Example
   Public Sub Main()
      Dim birthdate As Date = #7/28/1993#
      Dim dates() As Date = { #9/16/1993#, #7/28/1994#, #10/16/2000#, _
                              #7/27/2003#, #5/27/2007# }
      For Each dateValue As Date In dates
         Dim interval As TimeSpan = dateValue - birthdate
         ' Get the approximate number of years, without accounting for leap years.
         Dim years As Integer = CInt(interval.TotalDays) \ 365
         ' See if adding the number of years exceeds dateValue.
         Dim output As String
         If birthdate.AddYears(years) <= dateValue Then
            output = String.Format("You are now {0} years old.", years)
            Console.WriteLine(output)
         Else
            output = String.Format("You are now {0} years old.", years - 1)
            Console.WriteLine(output)   
         End If
      Next
   End Sub
End Module
' The example displays the following output:
'       You are now 0 years old.
'       You are now 1 years old.
'       You are now 7 years old.
'       You are now 9 years old.
'       You are now 13 years old.

См. также раздел

Применяется к

Format(IFormatProvider, CompositeFormat, Object[])

Исходный код:: String.Manipulation.cs

Исходный код:: String.Manipulation.cs

Заменяет элемент форматирования или элементы в на CompositeFormat строковое представление соответствующих объектов в указанном формате.

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

public static string Format (IFormatProvider? provider, System.Text.CompositeFormat format, params object?[] args);

static member Format : IFormatProvider * System.Text.CompositeFormat * obj[] -> string

Public Shared Function Format (provider As IFormatProvider, format As CompositeFormat, ParamArray args As Object()) As String

Параметры

provider: IFormatProvider

Объект, предоставляющий сведения о форматировании для определенного языка и региональных параметров.

format: CompositeFormat

CompositeFormat.

args: Object[]

Массив объектов для форматирования.

Возвращаемое значение

String

Форматированная строка.

Исключения

ArgumentNullException

Параметр format или args имеет значение null.

FormatException

Индекс элемента формата больше или равен количеству предоставленных аргументов.

Применяется к

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

Исходный код:: String.Manipulation.cs

Исходный код:: String.Manipulation.cs

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

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

static member Format : IFormatProvider * System.Text.CompositeFormat * 'TArg0 * 'TArg1 * 'TArg2 -> string

Public Shared Function Format(Of TArg0, TArg1, TArg2) (provider As IFormatProvider, format As CompositeFormat, arg0 As TArg0, arg1 As TArg1, arg2 As TArg2) As String

Параметры типа

TArg0

Тип первого отформатируемого объекта.

TArg1

Тип второго отформатируемого объекта.

TArg2

Тип третьего объекта для форматирования.

Параметры

provider: IFormatProvider

Объект, предоставляющий сведения о форматировании для определенного языка и региональных параметров.

format: CompositeFormat

CompositeFormat.

arg0: TArg0

Первый объект для форматирования.

arg1: TArg1

Второй объект для форматирования.

arg2: TArg2

Третий объект для форматирования.

Возвращаемое значение

String

Форматированная строка.

Исключения

ArgumentNullException

format имеет значение null.

FormatException

Индекс элемента формата больше или равен числу предоставленных аргументов.

Применяется к

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

Исходный код:: String.Manipulation.cs

Исходный код:: String.Manipulation.cs

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

public static string Format<TArg0,TArg1> (IFormatProvider? provider, System.Text.CompositeFormat format, TArg0 arg0, TArg1 arg1);

static member Format : IFormatProvider * System.Text.CompositeFormat * 'TArg0 * 'TArg1 -> string

Public Shared Function Format(Of TArg0, TArg1) (provider As IFormatProvider, format As CompositeFormat, arg0 As TArg0, arg1 As TArg1) As String

Параметры типа

TArg0

Тип первого отформатируемого объекта.

TArg1

Тип второго отформатируемого объекта.

Параметры

provider: IFormatProvider

Объект, предоставляющий сведения о форматировании для определенного языка и региональных параметров.

format: CompositeFormat

CompositeFormat.

arg0: TArg0

Первый объект для форматирования.

arg1: TArg1

Второй объект для форматирования.

Возвращаемое значение

String

Форматированная строка.

Исключения

ArgumentNullException

format имеет значение null.

FormatException

Индекс элемента формата больше или равен числу предоставленных аргументов.

Применяется к

Format<TArg0>(IFormatProvider, CompositeFormat, TArg0)

Исходный код:: String.Manipulation.cs

Исходный код:: String.Manipulation.cs

public:
generic <typename TArg0>
 static System::String ^ Format(IFormatProvider ^ provider, System::Text::CompositeFormat ^ format, TArg0 arg0);

public static string Format<TArg0> (IFormatProvider? provider, System.Text.CompositeFormat format, TArg0 arg0);

static member Format : IFormatProvider * System.Text.CompositeFormat * 'TArg0 -> string

Public Shared Function Format(Of TArg0) (provider As IFormatProvider, format As CompositeFormat, arg0 As TArg0) As String

Параметры типа

TArg0

Тип первого отформатируемого объекта.

Параметры

provider: IFormatProvider

Объект, предоставляющий сведения о форматировании для определенного языка и региональных параметров.

format: CompositeFormat

CompositeFormat.

arg0: TArg0

Первый объект для форматирования.

Возвращаемое значение

String

Форматированная строка.

Исключения

ArgumentNullException

format имеет значение null.

FormatException

Индекс элемента формата больше или равен числу предоставленных аргументов.

Применяется к

String.Format Метод

Определение

Перегрузки

Комментарии

Format(IFormatProvider, String, Object, Object, Object)

Параметры

Возвращаемое значение

Исключения

Комментарии

Применяется к

Format(String, Object, Object, Object)

Параметры

Возвращаемое значение

Исключения

Комментарии

Пример: форматирование трех аргументов

См. также раздел

Применяется к

Format(IFormatProvider, String, Object, Object)

Параметры

Возвращаемое значение

Исключения

Комментарии

Применяется к

Format(String, Object, Object)

Параметры

Возвращаемое значение

Исключения

Комментарии

Пример. Форматирование двух аргументов

См. также раздел

Применяется к

Format(IFormatProvider, CompositeFormat, ReadOnlySpan<Object>)

Параметры

Возвращаемое значение

Исключения

Применяется к

Format(IFormatProvider, String, Object)

Параметры

Возвращаемое значение

Исключения

Комментарии

Применяется к

Format(IFormatProvider, String, Object[])

Параметры

Возвращаемое значение

Исключения

Комментарии

Пример. Форматирование с учетом языка и региональных параметров

См. также раздел

Применяется к

Format(String, Object[])

Параметры

Возвращаемое значение

Исключения

Комментарии

Пример: форматирование более трех аргументов

См. также раздел

Применяется к

Format(String, Object)

Параметры

Возвращаемое значение

Исключения

Комментарии

Пример. Форматирование одного аргумента

См. также раздел

Применяется к

Format(IFormatProvider, CompositeFormat, Object[])

Параметры

Возвращаемое значение

Исключения

Применяется к

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

Параметры типа

Параметры

Возвращаемое значение

Исключения

Применяется к

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

Параметры типа