Partager via


TextTransformation.Write, méthode (String, array<Object )

Ajoute, à la sortie de texte générée, une chaîne mise en forme qui contient zéro, une ou plusieurs spécifications de format. Chaque spécification de format est remplacée par la représentation sous forme de chaîne d'un argument objet correspondant.

Espace de noms :  Microsoft.VisualStudio.TextTemplating
Assembly :  Microsoft.VisualStudio.TextTemplating.10.0 (dans Microsoft.VisualStudio.TextTemplating.10.0.dll)

Syntaxe

'Déclaration
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[]
)

Paramètres

  • format
    Type : System.String
    Chaîne qui contient zéro, une ou plusieurs spécifications de format.
  • args
    Type : array<System.Object[]
    Tableau d'objets à mettre en forme.

Exceptions

Exception Condition
ArgumentNullException

format est nullune référence null (Nothing en Visual Basic).

ou

args est nullune référence null (Nothing en Visual Basic).

FormatException

format n'est pas valide.

ArgumentOutOfRangeException

Une augmentation de la valeur du StringBuilder sous-jacent dépasserait MaxCapacity.

Notes

La méthode Write peut être utilisée directement dans un modèle de texte.

Exemples

L'exemple de code suivant montre l'appel de la méthode Write à partir d'un modèle de texte. Collez ce code dans un fichier de modèle de texte et exécutez la transformation du modèle de texte pour consulter les résultats.

<#
    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
#>

Cet exemple produit la sortie suivante :

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.

Sécurité .NET Framework

Voir aussi

Référence

TextTransformation Classe

Write, surcharge

Microsoft.VisualStudio.TextTemplating, espace de noms

GenerationEnvironment

StringBuilder

AppendFormat

MaxCapacity

ArgumentOutOfRangeException

FormatException

ArgumentNullException

Autres ressources

Mise en forme des types

Numeric Format Strings

Date and Time Format Strings

Chaînes de format d'énumération

How to: Append Text to the Generated Text