IndentedTextWriter Class (System.CodeDom.Compiler)

Switch View :
ScriptFree
.NET Framework Class Library
IndentedTextWriter Class

Provides a text writer that can indent new lines by a tab string token.

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    System.IO.TextWriter
      System.CodeDom.Compiler.IndentedTextWriter

Namespace:  System.CodeDom.Compiler
Assembly:  System (in System.dll)
Syntax

Visual Basic
<PermissionSetAttribute(SecurityAction.InheritanceDemand, Name := "FullTrust")> _
<PermissionSetAttribute(SecurityAction.LinkDemand, Name := "FullTrust")> _
Public Class IndentedTextWriter _
	Inherits TextWriter
C#
[PermissionSetAttribute(SecurityAction.InheritanceDemand, Name = "FullTrust")]
[PermissionSetAttribute(SecurityAction.LinkDemand, Name = "FullTrust")]
public class IndentedTextWriter : TextWriter
Visual C++
[PermissionSetAttribute(SecurityAction::InheritanceDemand, Name = L"FullTrust")]
[PermissionSetAttribute(SecurityAction::LinkDemand, Name = L"FullTrust")]
public ref class IndentedTextWriter : public TextWriter
F#
[<PermissionSetAttribute(SecurityAction.InheritanceDemand, Name = "FullTrust")>]
[<PermissionSetAttribute(SecurityAction.LinkDemand, Name = "FullTrust")>]
type IndentedTextWriter =  
    class
        inherit TextWriter
    end

The IndentedTextWriter type exposes the following members.

Constructors

  Name Description
Public method IndentedTextWriter(TextWriter) Initializes a new instance of the IndentedTextWriter class using the specified text writer and default tab string.
Public method IndentedTextWriter(TextWriter, String) Initializes a new instance of the IndentedTextWriter class using the specified text writer and tab string.
Top
Properties

  Name Description
Public property Encoding Gets the encoding for the text writer to use. (Overrides TextWriter.Encoding.)
Public property FormatProvider Gets an object that controls formatting. (Inherited from TextWriter.)
Public property Indent Gets or sets the number of spaces to indent.
Public property InnerWriter Gets the TextWriter to use.
Public property NewLine Gets or sets the new line character to use. (Overrides TextWriter.NewLine.)
Top
Methods

  Name Description
Public method Close Closes the document being written to. (Overrides TextWriter.Close().)
Public method CreateObjRef Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public method Dispose() Releases all resources used by the TextWriter object. (Inherited from TextWriter.)
Protected method Dispose(Boolean) Releases the unmanaged resources used by the TextWriter and optionally releases the managed resources. (Inherited from TextWriter.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Flush Flushes the stream. (Overrides TextWriter.Flush().)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method MemberwiseClone() Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method MemberwiseClone(Boolean) Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Protected method OutputTabs Outputs the tab string once for each level of indentation according to the Indent property.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method Write(Boolean) Writes the text representation of a Boolean value to the text stream. (Overrides TextWriter.Write(Boolean).)
Public method Write(Char) Writes a character to the text stream. (Overrides TextWriter.Write(Char).)
Public method Write(Char[]) Writes a character array to the text stream. (Overrides TextWriter.Write(Char[]).)
Public method Write(Decimal) Writes the text representation of a decimal value to the text stream. (Inherited from TextWriter.)
Public method Write(Double) Writes the text representation of a Double to the text stream. (Overrides TextWriter.Write(Double).)
Public method Write(Int32) Writes the text representation of an integer to the text stream. (Overrides TextWriter.Write(Int32).)
Public method Write(Int64) Writes the text representation of an 8-byte integer to the text stream. (Overrides TextWriter.Write(Int64).)
Public method Write(Object) Writes the text representation of an object to the text stream. (Overrides TextWriter.Write(Object).)
Public method Write(Single) Writes the text representation of a Single to the text stream. (Overrides TextWriter.Write(Single).)
Public method Write(String) Writes the specified string to the text stream. (Overrides TextWriter.Write(String).)
Public method Write(UInt32) Writes the text representation of a 4-byte unsigned integer to the text stream. (Inherited from TextWriter.)
Public method Write(UInt64) Writes the text representation of an 8-byte unsigned integer to the text stream. (Inherited from TextWriter.)
Public method Write(String, Object) Writes out a formatted string, using the same semantics as specified. (Overrides TextWriter.Write(String, Object).)
Public method Write(String, Object[]) Writes out a formatted string, using the same semantics as specified. (Overrides TextWriter.Write(String, Object[]).)
Public method Write(Char[], Int32, Int32) Writes a subarray of characters to the text stream. (Overrides TextWriter.Write(Char[], Int32, Int32).)
Public method Write(String, Object, Object) Writes out a formatted string, using the same semantics as specified. (Overrides TextWriter.Write(String, Object, Object).)
Public method Write(String, Object, Object, Object) Writes out a formatted string, using the same semantics as String.Format. (Inherited from TextWriter.)
Public method WriteLine() Writes a line terminator. (Overrides TextWriter.WriteLine().)
Public method WriteLine(Boolean) Writes the text representation of a Boolean, followed by a line terminator, to the text stream. (Overrides TextWriter.WriteLine(Boolean).)
Public method WriteLine(Char) Writes a character, followed by a line terminator, to the text stream. (Overrides TextWriter.WriteLine(Char).)
Public method WriteLine(Char[]) Writes a character array, followed by a line terminator, to the text stream. (Overrides TextWriter.WriteLine(Char[]).)
Public method WriteLine(Decimal) Writes the text representation of a decimal value followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public method WriteLine(Double) Writes the text representation of a Double, followed by a line terminator, to the text stream. (Overrides TextWriter.WriteLine(Double).)
Public method WriteLine(Int32) Writes the text representation of an integer, followed by a line terminator, to the text stream. (Overrides TextWriter.WriteLine(Int32).)
Public method WriteLine(Int64) Writes the text representation of an 8-byte integer, followed by a line terminator, to the text stream. (Overrides TextWriter.WriteLine(Int64).)
Public method WriteLine(Object) Writes the text representation of an object, followed by a line terminator, to the text stream. (Overrides TextWriter.WriteLine(Object).)
Public method WriteLine(Single) Writes the text representation of a Single, followed by a line terminator, to the text stream. (Overrides TextWriter.WriteLine(Single).)
Public method WriteLine(String) Writes the specified string, followed by a line terminator, to the text stream. (Overrides TextWriter.WriteLine(String).)
Public method WriteLine(UInt32) Writes the text representation of a UInt32, followed by a line terminator, to the text stream. (Overrides TextWriter.WriteLine(UInt32).)
Public method WriteLine(UInt64) Writes the text representation of an 8-byte unsigned integer followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public method WriteLine(String, Object) Writes out a formatted string, followed by a line terminator, using the same semantics as specified. (Overrides TextWriter.WriteLine(String, Object).)
Public method WriteLine(String, Object[]) Writes out a formatted string, followed by a line terminator, using the same semantics as specified. (Overrides TextWriter.WriteLine(String, Object[]).)
Public method WriteLine(Char[], Int32, Int32) Writes a subarray of characters, followed by a line terminator, to the text stream. (Overrides TextWriter.WriteLine(Char[], Int32, Int32).)
Public method WriteLine(String, Object, Object) Writes out a formatted string, followed by a line terminator, using the same semantics as specified. (Overrides TextWriter.WriteLine(String, Object, Object).)
Public method WriteLine(String, Object, Object, Object) Writes out a formatted string and a new line, using the same semantics as Format. (Inherited from TextWriter.)
Public method WriteLineNoTabs Writes the specified string to a line without tabs.
Top
Fields

  Name Description
Protected field CoreNewLine Stores the new line characters used for this TextWriter. (Inherited from TextWriter.)
Public field Static member DefaultTabString Specifies the default tab string. This field is constant.
Top
Remarks

IndentedTextWriter extends a TextWriter by providing methods that insert a tab string and track the current indentation level. Text formatted with multiple indentation levels is useful for generated code, so this class is used by CodeDOM code generator implementations.

The tab string is the string that each indentation consists of. Typically the tab string contains white space.

Note Note

This class contains a link demand and an inheritance demand at the class level that applies to all members. A SecurityException is thrown when either the immediate caller or the derived class does not have full-trust permission. For details about security demands, see Link Demands and Inheritance Demands.

Examples

The following code example demonstrates using an IndentedTextWriter to write text at different levels of indentation.

Visual Basic

Imports System
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


C#

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());
        }
    }
}


Visual C++

#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 );
}



Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
.NET Framework Security

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also

Reference