IndentedTextWriter Classe

Definição

Namespace:

System.CodeDom.Compiler

Assembly:

System.Runtime.dll

Origem:

IndentedTextWriter.cs

Fornece um text writer que pode recuar novas linhas por um token de cadeia de caracteres de tabulação.

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

public class IndentedTextWriter : System.IO.TextWriter

type IndentedTextWriter = class
    inherit TextWriter

Public Class IndentedTextWriter
Inherits TextWriter

Herança

Object

MarshalByRefObject

TextWriter

IndentedTextWriter

Exemplos

O exemplo de código a seguir demonstra como usar um IndentedTextWriter para escrever texto em diferentes níveis de recuo.

#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

Comentários

IndentedTextWriter estende um TextWriter fornecendo métodos que inserem uma cadeia de caracteres de tabulação e acompanham o nível de recuo atual. O texto formatado com vários níveis de recuo é útil para o código gerado, portanto, essa classe é usada pelas implementações do gerador de código CodeDOM.

A cadeia de caracteres de tabulação é a cadeia de caracteres da qual cada recuo consiste. Normalmente, a cadeia de caracteres de tabulação contém espaço em branco.

Observação

Esta classe contém uma demanda de link e uma demanda de herança no nível de classe que se aplica a todos os membros. Um SecurityException é lançado quando o chamador imediato ou a classe derivada não tem permissão de confiança total. Para obter detalhes sobre as demandas de segurança, consulte Vincular demandas e demandas de herança.

Construtores

IndentedTextWriter(TextWriter)	Inicializa uma nova instância da classe IndentedTextWriter usando o text writer e a cadeia de caracteres de tabulação padrão especificados.
IndentedTextWriter(TextWriter, String)	Inicializa uma nova instância da classe IndentedTextWriter usando o text writer e a cadeia de caracteres de tabulação especificados.

Campos

CoreNewLine	Armazena os caracteres de nova linha usados para esse TextWriter. (Herdado de TextWriter)
DefaultTabString	Especifica cadeia de caracteres de tabulação padrão. Este campo é constante.

Propriedades

Encoding	Obtém a codificação do text writer a ser usado.
FormatProvider	Obtém um objeto que controla a formatação. (Herdado de TextWriter)
Indent	Obtém ou define o número de espaços a serem recuados.
InnerWriter	Obtém o TextWriter a ser usado.
NewLine	Obtém ou define o caractere de nova linha a ser usado.

Métodos

Close()	Fecha o documento que está sendo gravado.
CreateObjRef(Type)	Cria um objeto que contém todas as informações relevantes necessárias para gerar um proxy usado para se comunicar com um objeto remoto. (Herdado de MarshalByRefObject)
Dispose()	Libera todos os recursos usados pelo objeto TextWriter. (Herdado de TextWriter)
Dispose(Boolean)	Libera os recursos não gerenciados usados pelo TextWriter e opcionalmente libera os recursos gerenciados. (Herdado de TextWriter)
DisposeAsync()	Realiza tarefas definidas pelo aplicativo associadas à liberação ou à redefinição de recursos não gerenciados de forma assíncrona.
Equals(Object)	Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object)
Flush()	Libera o fluxo.
FlushAsync()	Limpa todos os buffers para isso IndentedTextWriter de forma assíncrona e faz com que todos os dados armazenados em buffer sejam gravados no dispositivo subjacente.
FlushAsync(CancellationToken)	Limpa todos os buffers para isso IndentedTextWriter de forma assíncrona e faz com que todos os dados armazenados em buffer sejam gravados no dispositivo subjacente.
GetHashCode()	Serve como a função de hash padrão. (Herdado de Object)
GetLifetimeService()	Obsoleto. Recupera o objeto de serviço de tempo de vida atual que controla a política de ciclo de vida para esta instância. (Herdado de MarshalByRefObject)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
InitializeLifetimeService()	Obsoleto. Obtém um objeto de serviço de tempo de vida para controlar a política de tempo de vida para essa instância. (Herdado de MarshalByRefObject)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
MemberwiseClone(Boolean)	Cria uma cópia superficial do objeto MarshalByRefObject atual. (Herdado de MarshalByRefObject)
OutputTabs()	Gera a cadeia de caracteres de tabulação uma vez para cada nível de recuo, de acordo com a propriedade Indent.
OutputTabsAsync()	Gera as guias de forma assíncrona para o subjacente TextWriter com base no atual Indent.
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)
Write(Boolean)	Grava a representação de texto de um valor booliano no fluxo de texto.
Write(Char)	Grava um caractere no fluxo de texto.
Write(Char[])	Grava uma matriz de caracteres no fluxo de texto.
Write(Char[], Int32, Int32)	Grava uma submatriz de caracteres no fluxo de texto.
Write(Decimal)	Grava a representação de texto de um valor decimal no fluxo de texto. (Herdado de TextWriter)
Write(Double)	Grava a representação de texto de um Double no fluxo de texto.
Write(Int32)	Grava a representação de texto de um inteiro no fluxo de texto.
Write(Int64)	Grava a representação de texto de um inteiro de 8 bytes no fluxo de texto.
Write(Object)	Grava a representação de texto de um objeto no fluxo de texto.
Write(ReadOnlySpan<Char>)	Grava um intervalo de caracteres no fluxo de texto. (Herdado de TextWriter)
Write(Single)	Grava a representação de texto de um Single no fluxo de texto.
Write(String)	Grava a cadeia de caracteres especificada no fluxo de texto.
Write(String, Object)	Grava uma cadeia de caracteres formatada usando a mesma semântica, conforme especificado.
Write(String, Object, Object)	Grava uma cadeia de caracteres formatada usando a mesma semântica, conforme especificado.
Write(String, Object, Object, Object)	Grava uma cadeia de caracteres formatada no fluxo de texto usando a mesma semântica do método Format(String, Object, Object, Object). (Herdado de TextWriter)
Write(String, Object[])	Grava uma cadeia de caracteres formatada usando a mesma semântica, conforme especificado.
Write(StringBuilder)	Grava um construtor de cadeia de caracteres no fluxo de texto. (Herdado de TextWriter)
Write(UInt32)	Grava a representação de texto de um inteiro sem sinal de 4 bytes no fluxo de texto. (Herdado de TextWriter)
Write(UInt64)	Grava a representação de texto de um inteiro sem sinal de 8 bytes no fluxo de texto. (Herdado de TextWriter)
WriteAsync(Char)	Grava de forma assíncrona o especificado Char nas guias subjacentes TextWriter, inserindo guias no início de cada linha.
WriteAsync(Char[])	Grava uma matriz de caracteres no fluxo de texto de forma assíncrona. (Herdado de TextWriter)
WriteAsync(Char[], Int32, Int32)	Grava de forma assíncrona o número especificado de Chars do buffer especificado no subjacente TextWriter, começando no índice especificado e gerando guias no início de cada nova linha.
WriteAsync(ReadOnlyMemory<Char>, CancellationToken)	Grava de forma assíncrona os caracteres especificados nas guias subjacentes TextWriter, inserindo guias no início de cada linha.
WriteAsync(String)	Grava de forma assíncrona a cadeia de caracteres especificada nas guias subjacentes TextWriter, inserindo guias no início de cada linha.
WriteAsync(StringBuilder, CancellationToken)	Grava de forma assíncrona o conteúdo do especificado StringBuilder nas guias subjacentes TextWriter, inserindo guias no início de cada linha.
WriteLine()	Grava um terminador de linha.
WriteLine(Boolean)	Grava a representação de texto de um booliano seguido por um terminador de linha no fluxo de texto.
WriteLine(Char)	Grava um caractere seguido por um terminador de linha no fluxo de texto.
WriteLine(Char[])	Grava uma matriz de caracteres seguida por um terminador de linha no fluxo de texto.
WriteLine(Char[], Int32, Int32)	Grava uma submatriz de caracteres seguida por um terminador de linha no fluxo de texto.
WriteLine(Decimal)	Grava a representação de texto de um valor decimal no fluxo de texto, seguida por um terminador de linha. (Herdado de TextWriter)
WriteLine(Double)	Grava a representação de texto de um Double seguido por um terminador de linha no fluxo de texto.
WriteLine(Int32)	Grava a representação de texto de um inteiro seguido por um terminador de linha no fluxo de texto.
WriteLine(Int64)	Grava a representação de texto de um inteiro de 8 bytes seguido por um terminador de linha no fluxo de texto.
WriteLine(Object)	Grava a representação de texto de um objeto seguido por um terminador de linha no fluxo de texto.
WriteLine(ReadOnlySpan<Char>)	Grava a representação de texto de um intervalo de caracteres no fluxo de texto, seguido por um terminador de linha. (Herdado de TextWriter)
WriteLine(Single)	Grava a representação de texto de um Single seguido por um terminador de linha no fluxo de texto.
WriteLine(String)	Grava a cadeia de caracteres especificada seguida por um terminador de linha no fluxo de texto.
WriteLine(String, Object)	Grava uma cadeia de caracteres formatada seguida por um terminador de linha usando a mesma semântica especificada.
WriteLine(String, Object, Object)	Grava uma cadeia de caracteres formatada seguida por um terminador de linha usando a mesma semântica especificada.
WriteLine(String, Object, Object, Object)	Grava uma cadeia de caracteres formatada e uma nova linha no fluxo de texto, usando a mesma semântica que Format(String, Object). (Herdado de TextWriter)
WriteLine(String, Object[])	Grava uma cadeia de caracteres formatada seguida por um terminador de linha usando a mesma semântica especificada.
WriteLine(StringBuilder)	Grava a representação de texto de um construtor de cadeia de caracteres no fluxo de texto, seguida por um terminador de linha. (Herdado de TextWriter)
WriteLine(UInt32)	Grava a representação de texto de um UInt32 seguido por um terminador de linha no fluxo de texto.
WriteLine(UInt64)	Grava a representação de texto de um inteiro sem sinal de 8 bytes no fluxo de texto, seguido por um terminador de linha. (Herdado de TextWriter)
WriteLineAsync()	Grava de forma assíncrona o terminador de linha no subjacente TextWriter.
WriteLineAsync(Char)	Grava de forma assíncrona o especificado Char no subjacente TextWriter seguido por um terminador de linha, inserindo guias no início de cada linha.
WriteLineAsync(Char[])	Grava de forma assíncrona uma matriz de caracteres no fluxo de texto, seguida por um terminador de linha no fluxo. (Herdado de TextWriter)
WriteLineAsync(Char[], Int32, Int32)	Grava de forma assíncrona o número especificado de caracteres do buffer especificado seguido por um terminador de linha, no subjacente TextWriter, começando no índice especificado dentro do buffer, inserindo guias no início de cada linha.
WriteLineAsync(ReadOnlyMemory<Char>, CancellationToken)	Grava de forma assíncrona os caracteres especificados seguidos por um terminador de linha no subjacente TextWriter, inserindo guias no início de cada linha.
WriteLineAsync(String)	Grava de forma assíncrona a cadeia de caracteres especificada seguida por um terminador de linha no subjacente TextWriter, inserindo guias no início de cada linha.
WriteLineAsync(StringBuilder, CancellationToken)	Grava de forma assíncrona o conteúdo do especificado StringBuilder seguido por um terminador de linha no subjacente TextWriter, inserindo guias no início de cada linha.
WriteLineNoTabs(String)	Grava a cadeia de caracteres especificada em uma linha sem tabulações.
WriteLineNoTabsAsync(String)	Grava de forma assíncrona a cadeia de caracteres especificada na subjacente TextWriter sem inserir guias.

Métodos de Extensão

ConfigureAwait(IAsyncDisposable, Boolean)

Configura como as esperas nas tarefas retornadas de um descartável assíncrono são realizadas.