TextTransformation.Write 方法 (String, array<Object )

發行項
10/31/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 為 nullNull 參照 (即 Visual Basic 中的 Nothing)。 -或- args 為 nullNull 參照 (即 Visual Basic 中的 Nothing)。
FormatException	format 無效。
ArgumentOutOfRangeException	加大基礎 StringBuilder 的值會超過 MaxCapacity。

ArgumentNullException

format 為 nullNull 參照 (即 Visual Basic 中的 Nothing)。

-或-

args 為 nullNull 參照 (即 Visual Basic 中的 Nothing)。

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.