IndentedTextWriter Classe

Définition

Espace de noms:

System.CodeDom.Compiler

Assembly:

System.Runtime.dll

Source:

IndentedTextWriter.cs

Fournit un enregistreur de texte qui peut mettre en retrait de nouvelles lignes par un jeton de chaîne d’onglet.

public ref class IndentedTextWriter : System::IO::TextWriter

public class IndentedTextWriter : System.IO.TextWriter

type IndentedTextWriter = class
    inherit TextWriter

Public Class IndentedTextWriter
Inherits TextWriter

Héritage

Object

MarshalByRefObject

TextWriter

IndentedTextWriter

Exemples

L’exemple de code suivant illustre l’utilisation d’un IndentedTextWriter pour écrire du texte à différents niveaux de retrait.

#using <System.Drawing.dll>
#using <System.Windows.Forms.dll>
#using <System.dll>

using namespace System;
using namespace System::CodeDom;
using namespace System::CodeDom::Compiler;
using namespace System::ComponentModel;
using namespace System::IO;
using namespace System::Windows::Forms;
public ref class Form1: public System::Windows::Forms::Form
{
private:
   System::Windows::Forms::TextBox^ textBox1;

   String^ CreateMultilevelIndentString()
   {
      
      // Creates a TextWriter to use as the base output writer.
      System::IO::StringWriter^ baseTextWriter = gcnew System::IO::StringWriter;
      
      // Create an IndentedTextWriter and set the tab string to use 
      // as the indentation string for each indentation level.
      System::CodeDom::Compiler::IndentedTextWriter^ indentWriter = gcnew IndentedTextWriter( baseTextWriter,"    " );
      
      // Sets the indentation level.
      indentWriter->Indent = 0;
      
      // Output test strings at stepped indentations through a recursive loop method.
      WriteLevel( indentWriter, 0, 5 );
      
      // Return the resulting string from the base StringWriter.
      return baseTextWriter->ToString();
   }


   void WriteLevel( IndentedTextWriter^ indentWriter, int level, int totalLevels )
   {
      
      // Output a test string with a new-line character at the end.
      indentWriter->WriteLine( "This is a test phrase. Current indentation level: {0}", level );
      
      // If not yet at the highest recursion level, call this output method for the next level of indentation.
      if ( level < totalLevels )
      {
         
         // Increase the indentation count for the next level of indented output.
         indentWriter->Indent++;
         
         // Call the WriteLevel method to write test output for the next level of indentation.
         WriteLevel( indentWriter, level + 1, totalLevels );
         
         // Restores the indentation count for this level after the recursive branch method has returned.
         indentWriter->Indent--;
      }
      else
      // Outputs a string using the WriteLineNoTabs method.
            indentWriter->WriteLineNoTabs( "This is a test phrase written with the IndentTextWriter.WriteLineNoTabs method." );
      // Outputs a test string with a new-line character at the end.
      indentWriter->WriteLine( "This is a test phrase. Current indentation level: {0}", level );
   }


   void button1_Click( Object^ /*sender*/, System::EventArgs^ /*e*/ )
   {
      textBox1->Text = CreateMultilevelIndentString();
   }


public:
   Form1()
   {
      System::Windows::Forms::Button^ button1 = gcnew System::Windows::Forms::Button;
      this->textBox1 = gcnew System::Windows::Forms::TextBox;
      this->SuspendLayout();
      this->textBox1->Anchor = (System::Windows::Forms::AnchorStyles)(System::Windows::Forms::AnchorStyles::Top | System::Windows::Forms::AnchorStyles::Bottom | System::Windows::Forms::AnchorStyles::Left | System::Windows::Forms::AnchorStyles::Right);
      this->textBox1->Location = System::Drawing::Point( 8, 40 );
      this->textBox1->Multiline = true;
      this->textBox1->Name = "textBox1";
      this->textBox1->Size = System::Drawing::Size( 391, 242 );
      this->textBox1->TabIndex = 0;
      this->textBox1->Text = "";
      button1->Location = System::Drawing::Point( 11, 8 );
      button1->Name = "button1";
      button1->Size = System::Drawing::Size( 229, 23 );
      button1->TabIndex = 1;
      button1->Text = "Generate string using IndentedTextWriter";
      button1->Click += gcnew System::EventHandler( this, &Form1::button1_Click );
      this->AutoScaleBaseSize = System::Drawing::Size( 5, 13 );
      this->ClientSize = System::Drawing::Size( 407, 287 );
      this->Controls->Add( button1 );
      this->Controls->Add( this->textBox1 );
      this->Name = "Form1";
      this->Text = "IndentedTextWriter example";
      this->ResumeLayout( false );
   }

};


[STAThread]
int main()
{
   Application::Run( gcnew Form1 );
}

using System;
using System.CodeDom;
using System.CodeDom.Compiler;
using System.ComponentModel;
using System.IO;
using System.Windows.Forms;

namespace IndentedTextWriterExample
{
    public class Form1 : System.Windows.Forms.Form
    {
        private System.Windows.Forms.TextBox textBox1;

        private string CreateMultilevelIndentString()
        {
            // Creates a TextWriter to use as the base output writer.
            System.IO.StringWriter baseTextWriter = new System.IO.StringWriter();

            // Create an IndentedTextWriter and set the tab string to use
            // as the indentation string for each indentation level.
            System.CodeDom.Compiler.IndentedTextWriter indentWriter = new IndentedTextWriter(baseTextWriter, "    ");

            // Sets the indentation level.
            indentWriter.Indent = 0;

            // Output test strings at stepped indentations through a recursive loop method.
            WriteLevel(indentWriter, 0, 5);

            // Return the resulting string from the base StringWriter.
            return baseTextWriter.ToString();
        }

        private void WriteLevel(IndentedTextWriter indentWriter, int level, int totalLevels)
        {
            // Output a test string with a new-line character at the end.
            indentWriter.WriteLine("This is a test phrase. Current indentation level: "+level.ToString());

            // If not yet at the highest recursion level, call this output method for the next level of indentation.
            if( level < totalLevels )
            {
                // Increase the indentation count for the next level of indented output.
                indentWriter.Indent++;

                // Call the WriteLevel method to write test output for the next level of indentation.
                WriteLevel(indentWriter, level+1, totalLevels);

                // Restores the indentation count for this level after the recursive branch method has returned.
                indentWriter.Indent--;
            }
            else
            {
                // Outputs a string using the WriteLineNoTabs method.
                indentWriter.WriteLineNoTabs("This is a test phrase written with the IndentTextWriter.WriteLineNoTabs method.");
            }

            // Outputs a test string with a new-line character at the end.
            indentWriter.WriteLine("This is a test phrase. Current indentation level: "+level.ToString());
        }

        private void button1_Click(object sender, System.EventArgs e)
        {
            textBox1.Text = CreateMultilevelIndentString();
        }

        public Form1()
        {
            System.Windows.Forms.Button button1 = new System.Windows.Forms.Button();
            this.textBox1 = new System.Windows.Forms.TextBox();
            this.SuspendLayout();
            this.textBox1.Anchor = ((System.Windows.Forms.AnchorStyles)((((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Bottom)
                | System.Windows.Forms.AnchorStyles.Left)
                | System.Windows.Forms.AnchorStyles.Right)));
            this.textBox1.Location = new System.Drawing.Point(8, 40);
            this.textBox1.Multiline = true;
            this.textBox1.Name = "textBox1";
            this.textBox1.Size = new System.Drawing.Size(391, 242);
            this.textBox1.TabIndex = 0;
            this.textBox1.Text = "";
            button1.Location = new System.Drawing.Point(11, 8);
            button1.Name = "button1";
            button1.Size = new System.Drawing.Size(229, 23);
            button1.TabIndex = 1;
            button1.Text = "Generate string using IndentedTextWriter";
            button1.Click += new System.EventHandler(this.button1_Click);
            this.AutoScaleBaseSize = new System.Drawing.Size(5, 13);
            this.ClientSize = new System.Drawing.Size(407, 287);
            this.Controls.Add(button1);
            this.Controls.Add(this.textBox1);
            this.Name = "Form1";
            this.Text = "IndentedTextWriter example";
            this.ResumeLayout(false);
        }

        [STAThread]
        static void Main()
        {
            Application.Run(new Form1());
        }
    }
}

Imports System.CodeDom
Imports System.CodeDom.Compiler
Imports System.ComponentModel
Imports System.IO
Imports System.Windows.Forms

Public Class Form1
   Inherits System.Windows.Forms.Form
   Private textBox1 As System.Windows.Forms.TextBox 
   
   Private Function CreateMultilevelIndentString() As String
        ' Create a TextWriter to use as the base output writer.
        Dim baseTextWriter As New System.IO.StringWriter
      
        ' Create an IndentedTextWriter and set the tab string to use 
        ' as the indentation string for each indentation level.
        Dim indentWriter = New IndentedTextWriter(baseTextWriter, "    ")

        ' Set the indentation level.
        indentWriter.Indent = 0

        ' Output test strings at stepped indentations through a recursive loop method.
        WriteLevel(indentWriter, 0, 5)
      
        ' Return the resulting string from the base StringWriter.
        Return baseTextWriter.ToString()
    End Function

    Private Sub WriteLevel(ByVal indentWriter As IndentedTextWriter, ByVal level As Integer, ByVal totalLevels As Integer)
        ' Outputs a test string with a new-line character at the end.
        indentWriter.WriteLine(("This is a test phrase. Current indentation level: " + level.ToString()))

        ' If not yet at the highest recursion level, call this output method for the next level of indentation.
        If level < totalLevels Then
            ' Increase the indentation count for the next level of indented output.
            indentWriter.Indent += 1

            ' Call the WriteLevel method to write test output for the next level of indentation.
            WriteLevel(indentWriter, level + 1, totalLevels)

            ' Restores the indentation count for this level after the recursive branch method has returned.
            indentWriter.Indent -= 1

        Else
            ' Output a string using the WriteLineNoTabs method.
            indentWriter.WriteLineNoTabs("This is a test phrase written with the IndentTextWriter.WriteLineNoTabs method.")
        End If

        ' Outputs a test string with a new-line character at the end.
        indentWriter.WriteLine(("This is a test phrase. Current indentation level: " + level.ToString()))
    End Sub

    Private Sub button1_Click(ByVal sender As Object, ByVal e As System.EventArgs)
        textBox1.Text = CreateMultilevelIndentString()
    End Sub

    Public Sub New()
        Dim button1 As New System.Windows.Forms.Button
        Me.textBox1 = New System.Windows.Forms.TextBox
        Me.SuspendLayout()
        Me.textBox1.Anchor = CType(System.Windows.Forms.AnchorStyles.Top Or System.Windows.Forms.AnchorStyles.Bottom Or System.Windows.Forms.AnchorStyles.Left Or System.Windows.Forms.AnchorStyles.Right, System.Windows.Forms.AnchorStyles)
        Me.textBox1.Location = New System.Drawing.Point(8, 40)
        Me.textBox1.Multiline = True
        Me.textBox1.Name = "textBox1"
        Me.textBox1.Size = New System.Drawing.Size(391, 242)
        Me.textBox1.TabIndex = 0
        Me.textBox1.Text = ""
        button1.Location = New System.Drawing.Point(11, 8)
        button1.Name = "button1"
        button1.Size = New System.Drawing.Size(229, 23)
        button1.TabIndex = 1
        button1.Text = "Generate string using IndentedTextWriter"
        AddHandler button1.Click, AddressOf Me.button1_Click
        Me.AutoScaleBaseSize = New System.Drawing.Size(5, 13)
        Me.ClientSize = New System.Drawing.Size(407, 287)
        Me.Controls.Add(button1)
        Me.Controls.Add(Me.textBox1)
        Me.Name = "Form1"
        Me.Text = "IndentedTextWriter example"
        Me.ResumeLayout(False)
    End Sub

    <STAThread()> _
    Shared Sub Main()
        Application.Run(New Form1)
    End Sub
End Class

Remarques

IndentedTextWriter étend une TextWriter en fournissant des méthodes qui insèrent une chaîne de tabulation et suivent le niveau de retrait actuel. Le texte mis en forme avec plusieurs niveaux de retrait est utile pour le code généré. Cette classe est donc utilisée par les implémentations du générateur de code CodeDOM.

La chaîne tabulation est la chaîne dont se compose chaque retrait. En règle générale, la chaîne d’onglet contient des espaces blancs.

Note

Cette classe contient une demande de liaison et une demande d’héritage au niveau de la classe qui s’applique à tous les membres. Une SecurityException est levée lorsque l’appelant immédiat ou la classe dérivée n’a pas d’autorisation de confiance totale. Pour plus d’informations sur les demandes de sécurité, consultez Lier les demandes et demandes d’héritage.

Constructeurs

IndentedTextWriter(TextWriter)	Initialise une nouvelle instance de la classe IndentedTextWriter à l’aide de l’enregistreur de texte spécifié et de la chaîne d’onglet par défaut.
IndentedTextWriter(TextWriter, String)	Initialise une nouvelle instance de la classe IndentedTextWriter à l’aide de l’enregistreur de texte et de la chaîne de tabulation spécifiés.

Champs

CoreNewLine	Stocke les caractères de ligne utilisés pour cette TextWriter. (Hérité de TextWriter)
DefaultTabString	Spécifie la chaîne d’onglet par défaut. Ce champ est constant.

Propriétés

Encoding	Obtient l’encodage de l’enregistreur de texte à utiliser.
FormatProvider	Obtient un objet qui contrôle la mise en forme. (Hérité de TextWriter)
Indent	Obtient ou définit le nombre d’espaces à mettre en retrait.
InnerWriter	Obtient la TextWriter à utiliser.
NewLine	Obtient ou définit le nouveau caractère de ligne à utiliser.

Méthodes

Close()	Ferme le document en cours d’écriture.
CreateObjRef(Type)	Crée un objet qui contient toutes les informations pertinentes requises pour générer un proxy utilisé pour communiquer avec un objet distant. (Hérité de MarshalByRefObject)
Dispose()	Libère toutes les ressources utilisées par l’objet TextWriter. (Hérité de TextWriter)
Dispose(Boolean)	Libère les ressources non managées utilisées par le TextWriter et libère éventuellement les ressources managées. (Hérité de TextWriter)
DisposeAsync()	Effectue des tâches définies par l’application associées à la libération, à la libération ou à la réinitialisation asynchrone des ressources non managées.
Equals(Object)	Détermine si l’objet spécifié est égal à l’objet actuel. (Hérité de Object)
Flush()	Vide le flux.
FlushAsync()	Efface toutes les mémoires tampons pour cette IndentedTextWriter de manière asynchrone et provoque l’écriture de toutes les données mises en mémoire tampon sur l’appareil sous-jacent.
FlushAsync(CancellationToken)	Efface toutes les mémoires tampons pour cette IndentedTextWriter de manière asynchrone et provoque l’écriture de toutes les données mises en mémoire tampon sur l’appareil sous-jacent.
GetHashCode()	Sert de fonction de hachage par défaut. (Hérité de Object)
GetLifetimeService()	Obsolète. Récupère l’objet de service de durée de vie actuel qui contrôle la stratégie de durée de vie de cette instance. (Hérité de MarshalByRefObject)
GetType()	Obtient la Type de l’instance actuelle. (Hérité de Object)
InitializeLifetimeService()	Obsolète. Obtient un objet de service de durée de vie pour contrôler la stratégie de durée de vie de cette instance. (Hérité de MarshalByRefObject)
MemberwiseClone()	Crée une copie superficielle du Objectactuel. (Hérité de Object)
MemberwiseClone(Boolean)	Crée une copie superficielle de l’objet MarshalByRefObject actuel. (Hérité de MarshalByRefObject)
OutputTabs()	Génère la chaîne d’onglet une fois pour chaque niveau de retrait en fonction de la propriété Indent.
OutputTabsAsync()	Génère de manière asynchrone des onglets vers le TextWriter sous-jacent en fonction de la Indentactuelle.
ToString()	Retourne une chaîne qui représente l’objet actuel. (Hérité de Object)
Write(Boolean)	Écrit la représentation textuelle d’une valeur booléenne dans le flux de texte.
Write(Char)	Écrit un caractère dans le flux de texte.
Write(Char[])	Écrit un tableau de caractères dans le flux de texte.
Write(Char[], Int32, Int32)	Écrit un sous-tableau de caractères dans le flux de texte.
Write(Decimal)	Écrit la représentation textuelle d’une valeur décimale dans le flux de texte. (Hérité de TextWriter)
Write(Double)	Écrit la représentation textuelle d’un double dans le flux de texte.
Write(Int32)	Écrit la représentation textuelle d’un entier dans le flux de texte.
Write(Int64)	Écrit la représentation textuelle d’un entier de 8 octets dans le flux de texte.
Write(Object)	Écrit la représentation textuelle d’un objet dans le flux de texte.
Write(ReadOnlySpan<Char>)	Écrit une étendue de caractères dans le flux de texte. (Hérité de TextWriter)
Write(Single)	Écrit la représentation textuelle d’un single dans le flux de texte.
Write(String)	Écrit la chaîne spécifiée dans le flux de texte.
Write(String, Object)	Écrit une chaîne mise en forme à l’aide de la même sémantique que celle spécifiée.
Write(String, Object, Object)	Écrit une chaîne mise en forme à l’aide de la même sémantique que celle spécifiée.
Write(String, Object, Object, Object)	Écrit une chaîne mise en forme dans le flux de texte à l’aide de la même sémantique que la méthode Format(String, Object, Object, Object). (Hérité de TextWriter)
Write(String, Object[])	Écrit une chaîne mise en forme à l’aide de la même sémantique que celle spécifiée.
Write(String, ReadOnlySpan<Object>)	Écrit une chaîne mise en forme dans le flux de texte à l’aide de la même sémantique que Format(String, ReadOnlySpan<Object>). (Hérité de TextWriter)
Write(StringBuilder)	Écrit un générateur de chaînes dans le flux de texte. (Hérité de TextWriter)
Write(UInt32)	Écrit la représentation textuelle d’un entier non signé de 4 octets dans le flux de texte. (Hérité de TextWriter)
Write(UInt64)	Écrit la représentation textuelle d’un entier non signé de 8 octets dans le flux de texte. (Hérité de TextWriter)
WriteAsync(Char)	Écrit de façon asynchrone le Char spécifié dans le TextWritersous-jacent, en insérant des onglets au début de chaque ligne.
WriteAsync(Char[])	Écrit un tableau de caractères dans le flux de texte de manière asynchrone. (Hérité de TextWriter)
WriteAsync(Char[], Int32, Int32)	Écrit de façon asynchrone le nombre spécifié de Chars à partir de la mémoire tampon spécifiée dans le TextWritersous-jacent, en commençant à l’index spécifié et en plaçant les onglets au début de chaque nouvelle ligne.
WriteAsync(ReadOnlyMemory<Char>, CancellationToken)	Écrit de façon asynchrone les caractères spécifiés dans le TextWritersous-jacent, en insérant des onglets au début de chaque ligne.
WriteAsync(String)	Écrit de façon asynchrone la chaîne spécifiée dans le TextWritersous-jacent, en insérant des onglets au début de chaque ligne.
WriteAsync(StringBuilder, CancellationToken)	Écrit de manière asynchrone le contenu du StringBuilder spécifié dans le TextWritersous-jacent, en insérant des onglets au début de chaque ligne.
WriteLine()	Écrit un terminateur de ligne.
WriteLine(Boolean)	Écrit la représentation textuelle d’un booléen, suivi d’une marque de fin de ligne, dans le flux de texte.
WriteLine(Char)	Écrit un caractère, suivi d’un terminateur de ligne, dans le flux de texte.
WriteLine(Char[])	Écrit un tableau de caractères, suivi d’un terminateur de ligne, dans le flux de texte.
WriteLine(Char[], Int32, Int32)	Écrit un sous-narrateur de caractères, suivi d’un terminateur de ligne, dans le flux de texte.
WriteLine(Decimal)	Écrit la représentation textuelle d’une valeur décimale dans le flux de texte, suivie d’une marque de fin de ligne. (Hérité de TextWriter)
WriteLine(Double)	Écrit la représentation textuelle d’un double, suivie d’un terminateur de ligne, dans le flux de texte.
WriteLine(Int32)	Écrit la représentation textuelle d’un entier, suivie d’un terminateur de ligne, dans le flux de texte.
WriteLine(Int64)	Écrit la représentation textuelle d’un entier de 8 octets, suivi d’un terminateur de ligne, dans le flux de texte.
WriteLine(Object)	Écrit la représentation textuelle d’un objet, suivie d’un terminateur de ligne, dans le flux de texte.
WriteLine(ReadOnlySpan<Char>)	Écrit la représentation textuelle d’une étendue de caractères dans le flux de texte, suivie d’un terminateur de ligne. (Hérité de TextWriter)
WriteLine(Single)	Écrit la représentation textuelle d’un single, suivi d’un terminateur de ligne, dans le flux de texte.
WriteLine(String)	Écrit la chaîne spécifiée, suivie d’un terminateur de ligne, dans le flux de texte.
WriteLine(String, Object)	Écrit une chaîne mise en forme, suivie d’un terminateur de ligne, à l’aide de la même sémantique que celle spécifiée.
WriteLine(String, Object, Object)	Écrit une chaîne mise en forme, suivie d’un terminateur de ligne, à l’aide de la même sémantique que celle spécifiée.
WriteLine(String, Object, Object, Object)	Écrit une chaîne mise en forme et une nouvelle ligne dans le flux de texte à l’aide de la même sémantique que Format(String, Object). (Hérité de TextWriter)
WriteLine(String, Object[])	Écrit une chaîne mise en forme, suivie d’un terminateur de ligne, à l’aide de la même sémantique que celle spécifiée.
WriteLine(String, ReadOnlySpan<Object>)	Écrit une chaîne mise en forme et une nouvelle ligne dans le flux de texte à l’aide de la même sémantique que Format(String, ReadOnlySpan<Object>). (Hérité de TextWriter)
WriteLine(StringBuilder)	Écrit la représentation textuelle d’un générateur de chaînes dans le flux de texte, suivie d’une marque de fin de ligne. (Hérité de TextWriter)
WriteLine(UInt32)	Écrit la représentation textuelle d’un UInt32, suivi d’un terminateur de ligne, dans le flux de texte.
WriteLine(UInt64)	Écrit la représentation textuelle d’un entier non signé de 8 octets dans le flux de texte, suivie d’une marque de fin de ligne. (Hérité de TextWriter)
WriteLineAsync()	Écrit de façon asynchrone le terminateur de ligne dans le TextWritersous-jacent.
WriteLineAsync(Char)	Écrit de façon asynchrone le Char spécifié dans le TextWriter sous-jacent suivi d’un terminateur de ligne, en insérant des onglets au début de chaque ligne.
WriteLineAsync(Char[])	Écrit de façon asynchrone un tableau de caractères dans le flux de texte, suivi d’une marque de fin de ligne. (Hérité de TextWriter)
WriteLineAsync(Char[], Int32, Int32)	Écrit de manière asynchrone le nombre spécifié de caractères à partir de la mémoire tampon spécifiée suivie d’un point de terminaison de ligne, dans le TextWritersous-jacent, en commençant à l’index spécifié dans la mémoire tampon, en insérant des onglets au début de chaque ligne.
WriteLineAsync(ReadOnlyMemory<Char>, CancellationToken)	Écrit de façon asynchrone les caractères spécifiés suivis d’un terminateur de ligne dans le TextWritersous-jacent, en insérant des onglets au début de chaque ligne.
WriteLineAsync(String)	Écrit de façon asynchrone la chaîne spécifiée suivie d’un terminateur de ligne dans le TextWritersous-jacent, en insérant des onglets au début de chaque ligne.
WriteLineAsync(StringBuilder, CancellationToken)	Écrit de manière asynchrone le contenu du StringBuilder spécifié suivi d’un point de terminaison de ligne dans le TextWritersous-jacent, en insérant des onglets au début de chaque ligne.
WriteLineNoTabs(String)	Écrit la chaîne spécifiée dans une ligne sans onglets.
WriteLineNoTabsAsync(String)	Écrit de façon asynchrone la chaîne spécifiée dans le TextWriter sous-jacent sans insérer d’onglets.

Méthodes d’extension

ConfigureAwait(IAsyncDisposable, Boolean)

Configure la façon dont les attentes sur les tâches retournées à partir d’un jetable asynchrone sont effectuées.