IndentedTextWriter Klasa

Definicja

Przestrzeń nazw:

System.CodeDom.Compiler

Zestawy:

netstandard.dll, System.Runtime.dll

Źródło:

IndentedTextWriter.cs

Udostępnia moduł zapisywania tekstu, który może wciąć nowe wiersze za pomocą tokenu ciągu tabulacji.

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

public class IndentedTextWriter : System.IO.TextWriter

type IndentedTextWriter = class
    inherit TextWriter

Public Class IndentedTextWriter
Inherits TextWriter

Dziedziczenie

Object

MarshalByRefObject

TextWriter

IndentedTextWriter

Przykłady

W poniższym przykładzie kodu pokazano użycie elementu IndentedTextWriter do pisania tekstu na różnych poziomach wcięcia.

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

Uwagi

IndentedTextWriter rozszerza element TextWriter , podając metody, które wstawią ciąg tabulacji i śledzą bieżący poziom wcięcia. Tekst sformatowany przy użyciu wielu poziomów wcięcia jest przydatny w przypadku wygenerowanego kodu, więc ta klasa jest używana przez implementacje generatora kodu CodeDOM.

Ciąg tabulatora to ciąg, z którego składa się każde wcięcie. Zazwyczaj ciąg tabulacji zawiera białe znaki.

Nuta

Ta klasa zawiera żądanie łącza i żądanie dziedziczenia na poziomie klasy, który ma zastosowanie do wszystkich elementów członkowskich. Element SecurityException jest zgłaszany, gdy bezpośredni obiekt wywołujący lub klasa pochodna nie ma uprawnienia pełnego zaufania.

Konstruktory

Nazwa	Opis
IndentedTextWriter(TextWriter, String)	Inicjuje nowe wystąpienie IndentedTextWriter klasy przy użyciu określonego składnika zapisywania tekstu i ciągu tabulacji.
IndentedTextWriter(TextWriter)	Inicjuje nowe wystąpienie IndentedTextWriter klasy przy użyciu określonego składnika zapisywania tekstu i domyślnego ciągu tabulacji.

Pola

Nazwa	Opis
CoreNewLine	Przechowuje znaki nowego wiersza używane dla tego elementu TextWriter. (Odziedziczone po TextWriter)
DefaultTabString	Określa domyślny ciąg karty. To pole jest stałe.

Właściwości

Nazwa	Opis
Encoding	Pobiera kodowanie modułu zapisywania tekstu do użycia.
FormatProvider	Pobiera obiekt, który kontroluje formatowanie. (Odziedziczone po TextWriter)
Indent	Pobiera lub ustawia liczbę spacji na wcięcie.
InnerWriter	Pobiera element TextWriter do użycia.
NewLine	Pobiera lub ustawia nowy znak wiersza do użycia.

Metody

Nazwa	Opis
Close()	Zamyka zapisywany dokument.
Dispose()	Zwalnia wszystkie zasoby używane przez TextWriter obiekt. (Odziedziczone po TextWriter)
Dispose(Boolean)	Zwalnia niezarządzane zasoby używane przez TextWriter program i opcjonalnie zwalnia zarządzane zasoby. (Odziedziczone po TextWriter)
DisposeAsync()	Wykonuje zadania zdefiniowane przez aplikację skojarzone z zwalnianiem, zwalnianiem lub resetowaniem niezarządzanych zasobów asynchronicznie.
Equals(Object)	Określa, czy określony obiekt jest równy bieżącemu obiektowi. (Odziedziczone po Object)
Flush()	Opróżnia strumień.
FlushAsync()	Czyści wszystkie bufory dla tego IndentedTextWriter asynchronicznego i powoduje zapisanie wszystkich buforowanych danych na urządzeniu bazowym.
FlushAsync(CancellationToken)	Czyści wszystkie bufory dla tego IndentedTextWriter asynchronicznego i powoduje zapisanie wszystkich buforowanych danych na urządzeniu bazowym.
GetHashCode()	Służy jako domyślna funkcja skrótu. (Odziedziczone po Object)
GetLifetimeService()	Przestarzałe. Pobiera bieżący obiekt usługi okresu istnienia, który kontroluje zasady okresu istnienia dla tego wystąpienia. (Odziedziczone po MarshalByRefObject)
GetType()	Pobiera Type bieżącego wystąpienia. (Odziedziczone po Object)
InitializeLifetimeService()	Przestarzałe. Uzyskuje obiekt usługi okresu istnienia w celu kontrolowania zasad okresu istnienia dla tego wystąpienia. (Odziedziczone po MarshalByRefObject)
MemberwiseClone()	Tworzy płytkią kopię bieżącego Object. (Odziedziczone po Object)
MemberwiseClone(Boolean)	Tworzy płytkią kopię bieżącego MarshalByRefObject obiektu. (Odziedziczone po MarshalByRefObject)
OutputTabs()	Zwraca ciąg tabulatora raz dla każdego poziomu wcięcia zgodnie z właściwością Indent .
OutputTabsAsync()	Asynchronicznie wyprowadza karty do bazowego TextWriter elementu na podstawie bieżącego Indentelementu .
ToString()	Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Object)
Write(Boolean)	Zapisuje tekstową reprezentację wartości logicznej w strumieniu tekstowym.
Write(Char)	Zapisuje znak w strumieniu tekstowym.
Write(Char[], Int32, Int32)	Zapisuje podarraj znaków w strumieniu tekstowym.
Write(Char[])	Zapisuje tablicę znaków w strumieniu tekstowym.
Write(Decimal)	Zapisuje tekstową reprezentację wartości dziesiętnej w strumieniu tekstowym. (Odziedziczone po TextWriter)
Write(Double)	Zapisuje reprezentację tekstu podwójnej do strumienia tekstowego.
Write(Int32)	Zapisuje reprezentację tekstu liczby całkowitej w strumieniu tekstowym.
Write(Int64)	Zapisuje reprezentację tekstu liczby całkowitej 8-bajtowej w strumieniu tekstowym.
Write(Object)	Zapisuje tekstową reprezentację obiektu w strumieniu tekstowym.
Write(ReadOnlySpan<Char>)	Zapisuje zakres znaków w strumieniu tekstowym. (Odziedziczone po TextWriter)
Write(Single)	Zapisuje reprezentację tekstu pojedynczego w strumieniu tekstowym.
Write(String, Object, Object, Object)	Zapisuje sformatowany ciąg w strumieniu tekstowym przy użyciu tej samej semantyki co Format(String, Object, Object, Object) metoda. (Odziedziczone po TextWriter)
Write(String, Object, Object)	Zapisuje sformatowany ciąg przy użyciu tej samej semantyki, co określono.
Write(String, Object)	Zapisuje sformatowany ciąg przy użyciu tej samej semantyki, co określono.
Write(String, Object[])	Zapisuje sformatowany ciąg przy użyciu tej samej semantyki, co określono.
Write(String, ReadOnlySpan<Object>)	Zapisuje sformatowany ciąg przy użyciu tej samej semantyki, co określono.
Write(String)	Zapisuje określony ciąg w strumieniu tekstowym.
Write(StringBuilder)	Zapisuje konstruktora ciągów w strumieniu tekstowym. (Odziedziczone po TextWriter)
Write(UInt32)	Zapisuje reprezentację tekstu 4-bajtowej liczby całkowitej bez znaku do strumienia tekstowego. (Odziedziczone po TextWriter)
Write(UInt64)	Zapisuje reprezentację tekstu 8-bajtowej liczby całkowitej bez znaku do strumienia tekstowego. (Odziedziczone po TextWriter)
WriteAsync(Char)	Asynchronicznie zapisuje określony Char element w bazowym TextWriterobiekcie , wstawia karty na początku każdego wiersza.
WriteAsync(Char[], Int32, Int32)	Asynchronicznie zapisuje określoną liczbę Chars z określonego buforu do bazowego TextWriter, zaczynając od określonego indeksu, i wyświetlając karty na początku każdego nowego wiersza.
WriteAsync(Char[])	Zapisuje tablicę znaków w strumieniu tekstowym asynchronicznie. (Odziedziczone po TextWriter)
WriteAsync(ReadOnlyMemory<Char>, CancellationToken)	Asynchronicznie zapisuje określone znaki do bazowego TextWriter, wstawia karty na początku każdego wiersza.
WriteAsync(String)	Asynchronicznie zapisuje określony ciąg w bazowym TextWriterobiekcie , wstawia karty na początku każdego wiersza.
WriteAsync(StringBuilder, CancellationToken)	Asynchronicznie zapisuje zawartość określonego StringBuilder elementu do bazowego TextWriter, wstawia karty na początku każdego wiersza.
WriteLine()	Zapisuje terminator wierszy.
WriteLine(Boolean)	Zapisuje tekstową reprezentację wartości logicznej, po której następuje terminator wiersza, do strumienia tekstowego.
WriteLine(Char)	Zapisuje znak, po którym następuje terminator wiersza, do strumienia tekstowego.
WriteLine(Char[], Int32, Int32)	Zapisuje podarraj znaków, po którym następuje terminator wiersza, do strumienia tekstu.
WriteLine(Char[])	Zapisuje tablicę znaków, po której następuje terminator wiersza, do strumienia tekstowego.
WriteLine(Decimal)	Zapisuje tekstową reprezentację wartości dziesiętnej w strumieniu tekstowym, a następnie terminator wiersza. (Odziedziczone po TextWriter)
WriteLine(Double)	Zapisuje reprezentację tekstową elementu Double, po którym następuje terminator wiersza, do strumienia tekstowego.
WriteLine(Int32)	Zapisuje reprezentację tekstu liczby całkowitej, po której następuje terminator wiersza, do strumienia tekstowego.
WriteLine(Int64)	Zapisuje tekstową reprezentację 8-bajtowej liczby całkowitej, po której następuje terminator wiersza, do strumienia tekstu.
WriteLine(Object)	Zapisuje tekstową reprezentację obiektu, po którym następuje terminator wiersza, do strumienia tekstowego.
WriteLine(ReadOnlySpan<Char>)	Zapisuje tekstową reprezentację zakresu znaków w strumieniu tekstowym, po którym następuje terminator wiersza. (Odziedziczone po TextWriter)
WriteLine(Single)	Zapisuje tekstową reprezentację pojedynczego elementu, po którym następuje terminator wiersza, do strumienia tekstowego.
WriteLine(String, Object, Object, Object)	Zapisuje sformatowany ciąg i nowy wiersz do strumienia tekstowego przy użyciu tej samej semantyki co Format(String, Object). (Odziedziczone po TextWriter)
WriteLine(String, Object, Object)	Zapisuje sformatowany ciąg, po którym następuje terminator wierszy, używając tej samej semantyki co określony.
WriteLine(String, Object)	Zapisuje sformatowany ciąg, po którym następuje terminator wierszy, używając tej samej semantyki co określony.
WriteLine(String, Object[])	Zapisuje sformatowany ciąg, po którym następuje terminator wierszy, używając tej samej semantyki co określony.
WriteLine(String, ReadOnlySpan<Object>)	Zapisuje sformatowany ciąg, po którym następuje terminator wierszy, używając tej samej semantyki co określony.
WriteLine(String)	Zapisuje określony ciąg, po którym następuje terminator wiersza, do strumienia tekstowego.
WriteLine(StringBuilder)	Zapisuje tekstową reprezentację konstruktora ciągów w strumieniu tekstowym, a następnie terminator wiersza. (Odziedziczone po TextWriter)
WriteLine(UInt32)	Zapisuje tekstową reprezentację UInt32, po której następuje terminator wiersza, do strumienia tekstowego.
WriteLine(UInt64)	Zapisuje reprezentację tekstu 8-bajtowej liczby całkowitej bez znaku do strumienia tekstowego, a następnie terminator wiersza. (Odziedziczone po TextWriter)
WriteLineAsync()	Asynchronicznie zapisuje terminator wierszy w bazowym TextWriterobiekcie .
WriteLineAsync(Char)	Asynchronicznie zapisuje określony Char element do bazowego TextWriter , po którym następuje terminator wiersza, wstawia karty na początku każdego wiersza.
WriteLineAsync(Char[], Int32, Int32)	Asynchronicznie zapisuje określoną liczbę znaków z określonego buforu, po którym następuje terminator wiersza, do bazowego TextWriter, zaczynając od określonego indeksu w buforze, wstawia karty na początku każdego wiersza.
WriteLineAsync(Char[])	Asynchronicznie zapisuje tablicę znaków w strumieniu tekstowym, a następnie terminator wiersza. (Odziedziczone po TextWriter)
WriteLineAsync(ReadOnlyMemory<Char>, CancellationToken)	Asynchronicznie zapisuje określone znaki, po których następuje terminator wiersza do bazowego TextWriter, wstawia karty na początku każdego wiersza.
WriteLineAsync(String)	Asynchronicznie zapisuje określony ciąg, po którym następuje terminator wiersza do bazowego TextWriter, wstawia karty na początku każdego wiersza.
WriteLineAsync(StringBuilder, CancellationToken)	Asynchronicznie zapisuje zawartość określonego StringBuilder wiersza, po którym następuje terminator wiersza do bazowego TextWriter, wstawia karty na początku każdego wiersza.
WriteLineNoTabs(String)	Zapisuje określony ciąg w wierszu bez kart.
WriteLineNoTabsAsync(String)	Asynchronicznie zapisuje określony ciąg do bazowego TextWriter bez wstawiania kart.

Metody rozszerzania

Nazwa	Opis
ConfigureAwait(IAsyncDisposable, Boolean)	Konfiguruje, w jaki sposób będą wykonywane oczekiwania na zadania zwrócone z asynchronicznego jednorazowego użytku.