IndentedTextWriter Clase

Definición

Espacio de nombres:

System.CodeDom.Compiler

Ensamblado:

System.Runtime.dll

Source:

IndentedTextWriter.cs

Proporciona un escritor de texto que puede sangr nuevas líneas mediante un token de cadena de tabulación.

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

public class IndentedTextWriter : System.IO.TextWriter

type IndentedTextWriter = class
    inherit TextWriter

Public Class IndentedTextWriter
Inherits TextWriter

Herencia

Object

MarshalByRefObject

TextWriter

IndentedTextWriter

Ejemplos

En el ejemplo de código siguiente se muestra el uso de un IndentedTextWriter para escribir texto en distintos niveles de sangría.

#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

Comentarios

IndentedTextWriter extiende un TextWriter proporcionando métodos que insertan una cadena de tabulación y realizan un seguimiento del nivel de sangría actual. El texto con formato con varios niveles de sangría es útil para el código generado, por lo que las implementaciones del generador de código CodeDOM usan esta clase.

La cadena de tabulación es la cadena de la que consta cada sangría. Normalmente, la cadena de tabulación contiene espacios en blanco.

Nota

Esta clase contiene una demanda de vínculo y una demanda de herencia en el nivel de clase que se aplica a todos los miembros. Se produce un SecurityException cuando el llamador inmediato o la clase derivada no tienen permiso de plena confianza. Para obtener más información sobre las demandas de seguridad, consulte de demandas de vínculo y demandas de herencia.

Constructores

IndentedTextWriter(TextWriter)	Inicializa una nueva instancia de la clase IndentedTextWriter mediante el escritor de texto especificado y la cadena de tabulación predeterminada.
IndentedTextWriter(TextWriter, String)	Inicializa una nueva instancia de la clase IndentedTextWriter mediante el escritor de texto y la cadena de tabulación especificados.

Campos

CoreNewLine	Almacena los caracteres de nueva línea usados para este TextWriter. (Heredado de TextWriter)
DefaultTabString	Especifica la cadena de tabulación predeterminada. Este campo es constante.

Propiedades

Encoding	Obtiene la codificación del escritor de texto que se va a usar.
FormatProvider	Obtiene un objeto que controla el formato. (Heredado de TextWriter)
Indent	Obtiene o establece el número de espacios en sangría.
InnerWriter	Obtiene el TextWriter que se va a usar.
NewLine	Obtiene o establece el nuevo carácter de línea que se va a usar.

Métodos

Close()	Cierra el documento en el que se está escribiendo.
CreateObjRef(Type)	Crea un objeto que contiene toda la información pertinente necesaria para generar un proxy usado para comunicarse con un objeto remoto. (Heredado de MarshalByRefObject)
Dispose()	Libera todos los recursos utilizados por el objeto TextWriter. (Heredado de TextWriter)
Dispose(Boolean)	Libera los recursos no administrados usados por el TextWriter y, opcionalmente, libera los recursos administrados. (Heredado de TextWriter)
DisposeAsync()	Realiza tareas definidas por la aplicación asociadas a la liberación, liberación o restablecimiento de recursos no administrados de forma asincrónica.
Equals(Object)	Determina si el objeto especificado es igual al objeto actual. (Heredado de Object)
Flush()	Vacía la secuencia.
FlushAsync()	Borra todos los búferes de este IndentedTextWriter de forma asincrónica y hace que los datos almacenados en búfer se escriban en el dispositivo subyacente.
FlushAsync(CancellationToken)	Borra todos los búferes de este IndentedTextWriter de forma asincrónica y hace que los datos almacenados en búfer se escriban en el dispositivo subyacente.
GetHashCode()	Actúa como función hash predeterminada. (Heredado de Object)
GetLifetimeService()	Obsoletos. Recupera el objeto de servicio de duración actual que controla la directiva de duración de esta instancia. (Heredado de MarshalByRefObject)
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
InitializeLifetimeService()	Obsoletos. Obtiene un objeto de servicio de duración para controlar la directiva de duración de esta instancia. (Heredado de MarshalByRefObject)
MemberwiseClone()	Crea una copia superficial del Objectactual. (Heredado de Object)
MemberwiseClone(Boolean)	Crea una copia superficial del objeto MarshalByRefObject actual. (Heredado de MarshalByRefObject)
OutputTabs()	Genera la cadena de tabulación una vez para cada nivel de sangría según la propiedad Indent.
OutputTabsAsync()	Genera de forma asincrónica pestañas en el TextWriter subyacente en función del Indentactual.
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)
Write(Boolean)	Escribe la representación de texto de un valor booleano en la secuencia de texto.
Write(Char)	Escribe un carácter en la secuencia de texto.
Write(Char[])	Escribe una matriz de caracteres en la secuencia de texto.
Write(Char[], Int32, Int32)	Escribe una subbarra de caracteres en la secuencia de texto.
Write(Decimal)	Escribe la representación de texto de un valor decimal en la secuencia de texto. (Heredado de TextWriter)
Write(Double)	Escribe la representación de texto de un valor Double en la secuencia de texto.
Write(Int32)	Escribe la representación de texto de un entero en la secuencia de texto.
Write(Int64)	Escribe la representación de texto de un entero de 8 bytes en la secuencia de texto.
Write(Object)	Escribe la representación de texto de un objeto en la secuencia de texto.
Write(ReadOnlySpan<Char>)	Escribe un intervalo de caracteres en la secuencia de texto. (Heredado de TextWriter)
Write(Single)	Escribe la representación de texto de un valor Single en la secuencia de texto.
Write(String)	Escribe la cadena especificada en la secuencia de texto.
Write(String, Object)	Escribe una cadena con formato, utilizando la misma semántica que se especifica.
Write(String, Object, Object)	Escribe una cadena con formato, utilizando la misma semántica que se especifica.
Write(String, Object, Object, Object)	Escribe una cadena con formato en la secuencia de texto, utilizando la misma semántica que el método Format(String, Object, Object, Object). (Heredado de TextWriter)
Write(String, Object[])	Escribe una cadena con formato, utilizando la misma semántica que se especifica.
Write(String, ReadOnlySpan<Object>)	Escribe una cadena con formato en la secuencia de texto, con la misma semántica que Format(String, ReadOnlySpan<Object>). (Heredado de TextWriter)
Write(StringBuilder)	Escribe un generador de cadenas en la secuencia de texto. (Heredado de TextWriter)
Write(UInt32)	Escribe la representación de texto de un entero de 4 bytes sin signo en la secuencia de texto. (Heredado de TextWriter)
Write(UInt64)	Escribe la representación de texto de un entero de 8 bytes sin signo en la secuencia de texto. (Heredado de TextWriter)
WriteAsync(Char)	Escribe de forma asincrónica el Char especificado en el TextWritersubyacente , insertando pestañas al principio de cada línea.
WriteAsync(Char[])	Escribe una matriz de caracteres en la secuencia de texto de forma asincrónica. (Heredado de TextWriter)
WriteAsync(Char[], Int32, Int32)	Escribe de forma asincrónica el número especificado de Chars del búfer especificado en el TextWritersubyacente, empezando por el índice especificado y las pestañas de salida al principio de cada nueva línea.
WriteAsync(ReadOnlyMemory<Char>, CancellationToken)	Escribe asincrónicamente los caracteres especificados en el TextWritersubyacente , insertando pestañas al principio de cada línea.
WriteAsync(String)	Escribe de forma asincrónica la cadena especificada en el TextWritersubyacente , insertando pestañas al principio de cada línea.
WriteAsync(StringBuilder, CancellationToken)	Escribe de forma asincrónica el contenido del StringBuilder especificado en el TextWritersubyacente , insertando pestañas al principio de cada línea.
WriteLine()	Escribe un terminador de línea.
WriteLine(Boolean)	Escribe la representación de texto de un booleano, seguido de un terminador de línea, en la secuencia de texto.
WriteLine(Char)	Escribe un carácter, seguido de un terminador de línea, en la secuencia de texto.
WriteLine(Char[])	Escribe una matriz de caracteres, seguida de un terminador de línea, en la secuencia de texto.
WriteLine(Char[], Int32, Int32)	Escribe una subbarra de caracteres, seguida de un terminador de línea, en la secuencia de texto.
WriteLine(Decimal)	Escribe la representación de texto de un valor decimal en la secuencia de texto, seguida de un terminador de línea. (Heredado de TextWriter)
WriteLine(Double)	Escribe la representación de texto de un double, seguido de un terminador de línea, en la secuencia de texto.
WriteLine(Int32)	Escribe la representación de texto de un entero, seguido de un terminador de línea, en la secuencia de texto.
WriteLine(Int64)	Escribe la representación de texto de un entero de 8 bytes, seguido de un terminador de línea, en la secuencia de texto.
WriteLine(Object)	Escribe la representación de texto de un objeto, seguido de un terminador de línea, en la secuencia de texto.
WriteLine(ReadOnlySpan<Char>)	Escribe la representación de texto de un intervalo de caracteres en la secuencia de texto, seguida de un terminador de línea. (Heredado de TextWriter)
WriteLine(Single)	Escribe la representación de texto de un valor Single, seguido de un terminador de línea, en la secuencia de texto.
WriteLine(String)	Escribe la cadena especificada, seguida de un terminador de línea, en la secuencia de texto.
WriteLine(String, Object)	Escribe una cadena con formato, seguida de un terminador de línea, utilizando la misma semántica que se especifica.
WriteLine(String, Object, Object)	Escribe una cadena con formato, seguida de un terminador de línea, utilizando la misma semántica que se especifica.
WriteLine(String, Object, Object, Object)	Escribe una cadena con formato y una nueva línea en la secuencia de texto, con la misma semántica que Format(String, Object). (Heredado de TextWriter)
WriteLine(String, Object[])	Escribe una cadena con formato, seguida de un terminador de línea, utilizando la misma semántica que se especifica.
WriteLine(String, ReadOnlySpan<Object>)	Escribe una cadena con formato y una nueva línea en la secuencia de texto, con la misma semántica que Format(String, ReadOnlySpan<Object>). (Heredado de TextWriter)
WriteLine(StringBuilder)	Escribe la representación de texto de un generador de cadenas en la secuencia de texto, seguida de un terminador de línea. (Heredado de TextWriter)
WriteLine(UInt32)	Escribe la representación de texto de un UInt32, seguido de un terminador de línea, en la secuencia de texto.
WriteLine(UInt64)	Escribe la representación de texto de un entero de 8 bytes sin signo en la secuencia de texto, seguida de un terminador de línea. (Heredado de TextWriter)
WriteLineAsync()	Escribe de forma asincrónica el terminador de línea en el TextWritersubyacente.
WriteLineAsync(Char)	Escribe de forma asincrónica el Char especificado en el TextWriter subyacente seguido de un terminador de línea, insertando pestañas al principio de cada línea.
WriteLineAsync(Char[])	Escribe de forma asincrónica una matriz de caracteres en la secuencia de texto, seguida de un terminador de línea. (Heredado de TextWriter)
WriteLineAsync(Char[], Int32, Int32)	Escribe de forma asincrónica el número especificado de caracteres del búfer especificado seguido de un terminador de línea, en el TextWritersubyacente, comenzando en el índice especificado dentro del búfer, insertando pestañas al principio de cada línea.
WriteLineAsync(ReadOnlyMemory<Char>, CancellationToken)	Escribe de forma asincrónica los caracteres especificados seguidos de un terminador de línea en el TextWritersubyacente , insertando pestañas al principio de cada línea.
WriteLineAsync(String)	Escribe de forma asincrónica la cadena especificada seguida de un terminador de línea en el TextWritersubyacente , insertando pestañas al principio de cada línea.
WriteLineAsync(StringBuilder, CancellationToken)	Escribe de forma asincrónica el contenido del StringBuilder especificado seguido de un terminador de línea en el TextWritersubyacente , insertando pestañas al principio de cada línea.
WriteLineNoTabs(String)	Escribe la cadena especificada en una línea sin tabulaciones.
WriteLineNoTabsAsync(String)	Escribe asincrónicamente la cadena especificada en el TextWriter subyacente sin insertar pestañas.

Métodos de extensión

ConfigureAwait(IAsyncDisposable, Boolean)

Configura cómo se realizarán las esperas en las tareas devueltas desde un descartable asincrónico.