TextTransformation.Write - метод (String, array<Object )

Статья
11/01/2012

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

Пространство имен: Microsoft.VisualStudio.TextTemplating
Сборка: Microsoft.VisualStudio.TextTemplating.11.0 (в Microsoft.VisualStudio.TextTemplating.11.0.dll)

Синтаксис

'Декларация
Public Sub Write ( _
    format As String, _
    ParamArray args As Object() _
)

public void Write(
    string format,
    params Object[] args
)

public:
void Write(
    String^ format, 
    ... array<Object^>^ args
)

member Write : 
        format:string * 
        args:Object[] -> unit

public function Write(
    format : String, 
    ... args : Object[]
)

Параметры

format
Тип: System.String
Строка, содержащая нуль или несколько спецификаций формата.

args
Тип: array<System.Object[]
Массив объектов для форматирования.

Исключения

Исключение	Условие
ArgumentNullException	Параметр format имеет значение nullссылка NULL (Nothing в Visual Basic). -или- Параметр args имеет значение nullссылка NULL (Nothing в Visual Basic).
FormatException	Значение параметра format недопустимо.
ArgumentOutOfRangeException	При увеличении значения базового StringBuilder будет превышено значение MaxCapacity.

ArgumentNullException

Параметр format имеет значение nullссылка NULL (Nothing в Visual Basic).

-или-

Параметр args имеет значение nullссылка NULL (Nothing в Visual Basic).

FormatException

Значение параметра format недопустимо.

ArgumentOutOfRangeException

При увеличении значения базового StringBuilder будет превышено значение MaxCapacity.

Заметки

Метод Write может использоваться непосредственно в текстовом шаблоне.

Примеры

В следующем примере кода показан вызов метода Write из текстового шаблона.Вставьте этот код в любой файл шаблона текста и запустите преобразование шаблона текста, чтобы увидеть результаты.

<#
    string message = @"{0}: This is text to append number {1:F}.";

    Write(message, 0, 0);          //Using the Write method
    WriteLine(null);               //Using the WriteLine method
    WriteLine(null);               //Using the WriteLine method
    
    for(int j=1; j<4; j++)
    {
        WriteLine(message, j, j);  //Using the WriteLine method
    }
#>

<#
    Dim message as String = "{0}: This is text to append number {1:F}."
    Dim j as Integer = 0

    Write(message, 0, 0)          'Using the Write method
    WriteLine(Nothing)            'Using the WriteLine method
    WriteLine(Nothing)            'Using the WriteLine method
    
    For j = 1 To 3

        WriteLine(message, j, j)  'Using the WriteLine method
    Next
#>

В этом примере получается следующий результат:

0: This is text to append number 0.00.

1: This is text to append number 1.00.

2: This is text to append number 2.00.

3: This is text to append number 3.00.

Безопасность платформы .NET Framework

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Дополнительные сведения см. в разделе Использование библиотек из не вполне надежного кода.