Export (0) Print
Expand All

IndentedTextWriter Class

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

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

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

public class IndentedTextWriter : TextWriter

The IndentedTextWriter type exposes the following members.

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

  NameDescription
Public propertyEncodingGets the encoding for the text writer to use. (Overrides TextWriter.Encoding.)
Public propertyFormatProviderGets an object that controls formatting. (Inherited from TextWriter.)
Public propertyIndentGets or sets the number of spaces to indent.
Public propertyInnerWriterGets the TextWriter to use.
Public propertyNewLineGets or sets the new line character to use. (Overrides TextWriter.NewLine.)
Top

  NameDescription
Public methodCloseCloses the document being written to. (Overrides TextWriter.Close().)
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public methodDispose()Releases all resources used by the TextWriter object. (Inherited from TextWriter.)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the TextWriter and optionally releases the managed resources. (Inherited from TextWriter.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodFlushFlushes the stream. (Overrides TextWriter.Flush().)
Public methodFlushAsyncAsynchronously clears all buffers for the current writer and causes any buffered data to be written to the underlying device. (Inherited from TextWriter.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected methodMemberwiseClone()Creates a shallow copy of the current Object. (Inherited from Object.)
Protected methodMemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Protected methodOutputTabsOutputs the tab string once for each level of indentation according to the Indent property.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodWrite(Boolean)Writes the text representation of a Boolean value to the text stream. (Overrides TextWriter.Write(Boolean).)
Public methodWrite(Char)Writes a character to the text stream. (Overrides TextWriter.Write(Char).)
Public methodWrite(Char[])Writes a character array to the text stream. (Overrides TextWriter.Write(Char[]).)
Public methodWrite(Decimal)Writes the text representation of a decimal value to the text string or stream. (Inherited from TextWriter.)
Public methodWrite(Double)Writes the text representation of a Double to the text stream. (Overrides TextWriter.Write(Double).)
Public methodWrite(Int32)Writes the text representation of an integer to the text stream. (Overrides TextWriter.Write(Int32).)
Public methodWrite(Int64)Writes the text representation of an 8-byte integer to the text stream. (Overrides TextWriter.Write(Int64).)
Public methodWrite(Object)Writes the text representation of an object to the text stream. (Overrides TextWriter.Write(Object).)
Public methodWrite(Single)Writes the text representation of a Single to the text stream. (Overrides TextWriter.Write(Single).)
Public methodWrite(String)Writes the specified string to the text stream. (Overrides TextWriter.Write(String).)
Public methodWrite(UInt32)Writes the text representation of a 4-byte unsigned integer to the text string or stream. (Inherited from TextWriter.)
Public methodWrite(UInt64)Writes the text representation of an 8-byte unsigned integer to the text string or stream. (Inherited from TextWriter.)
Public methodWrite(String, Object)Writes out a formatted string, using the same semantics as specified. (Overrides TextWriter.Write(String, Object).)
Public methodWrite(String, Object[])Writes out a formatted string, using the same semantics as specified. (Overrides TextWriter.Write(String, Object[]).)
Public methodWrite(Char[], Int32, Int32)Writes a subarray of characters to the text stream. (Overrides TextWriter.Write(Char[], Int32, Int32).)
Public methodWrite(String, Object, Object)Writes out a formatted string, using the same semantics as specified. (Overrides TextWriter.Write(String, Object, Object).)
Public methodWrite(String, Object, Object, Object)Writes a formatted string to the text string or stream, using the same semantics as the String.Format(String, Object, Object, Object) method. (Inherited from TextWriter.)
Public methodWriteAsync(Char)Writes a character to the text string or stream asynchronously. (Inherited from TextWriter.)
Public methodWriteAsync(Char[])Writes a character array to the text string or stream asynchronously. (Inherited from TextWriter.)
Public methodWriteAsync(String)Writes a string to the text string or stream asynchronously. (Inherited from TextWriter.)
Public methodWriteAsync(Char[], Int32, Int32)Writes a subarray of characters to the text string or stream asynchronously. (Inherited from TextWriter.)
Public methodWriteLine()Writes a line terminator. (Overrides TextWriter.WriteLine().)
Public methodWriteLine(Boolean)Writes the text representation of a Boolean, followed by a line terminator, to the text stream. (Overrides TextWriter.WriteLine(Boolean).)
Public methodWriteLine(Char)Writes a character, followed by a line terminator, to the text stream. (Overrides TextWriter.WriteLine(Char).)
Public methodWriteLine(Char[])Writes a character array, followed by a line terminator, to the text stream. (Overrides TextWriter.WriteLine(Char[]).)
Public methodWriteLine(Decimal)Writes the text representation of a decimal value followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodWriteLine(Double)Writes the text representation of a Double, followed by a line terminator, to the text stream. (Overrides TextWriter.WriteLine(Double).)
Public methodWriteLine(Int32)Writes the text representation of an integer, followed by a line terminator, to the text stream. (Overrides TextWriter.WriteLine(Int32).)
Public methodWriteLine(Int64)Writes the text representation of an 8-byte integer, followed by a line terminator, to the text stream. (Overrides TextWriter.WriteLine(Int64).)
Public methodWriteLine(Object)Writes the text representation of an object, followed by a line terminator, to the text stream. (Overrides TextWriter.WriteLine(Object).)
Public methodWriteLine(Single)Writes the text representation of a Single, followed by a line terminator, to the text stream. (Overrides TextWriter.WriteLine(Single).)
Public methodWriteLine(String)Writes the specified string, followed by a line terminator, to the text stream. (Overrides TextWriter.WriteLine(String).)
Public methodWriteLine(UInt32)Writes the text representation of a UInt32, followed by a line terminator, to the text stream. (Overrides TextWriter.WriteLine(UInt32).)
Public methodWriteLine(UInt64)Writes the text representation of an 8-byte unsigned integer followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodWriteLine(String, Object)Writes out a formatted string, followed by a line terminator, using the same semantics as specified. (Overrides TextWriter.WriteLine(String, Object).)
Public methodWriteLine(String, Object[])Writes out a formatted string, followed by a line terminator, using the same semantics as specified. (Overrides TextWriter.WriteLine(String, Object[]).)
Public methodWriteLine(Char[], Int32, Int32)Writes a subarray of characters, followed by a line terminator, to the text stream. (Overrides TextWriter.WriteLine(Char[], Int32, Int32).)
Public methodWriteLine(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 methodWriteLine(String, Object, Object, Object)Writes out a formatted string and a new line, using the same semantics as Format. (Inherited from TextWriter.)
Public methodWriteLineAsync()Writes a line terminator asynchronously to the text string or stream. (Inherited from TextWriter.)
Public methodWriteLineAsync(Char)Writes a character followed by a line terminator asynchronously to the text string or stream. (Inherited from TextWriter.)
Public methodWriteLineAsync(Char[])Writes an array of characters followed by a line terminator asynchronously to the text string or stream. (Inherited from TextWriter.)
Public methodWriteLineAsync(String)Writes a string followed by a line terminator asynchronously to the text string or stream. (Inherited from TextWriter.)
Public methodWriteLineAsync(Char[], Int32, Int32)Writes a subarray of characters followed by a line terminator asynchronously to the text string or stream. (Inherited from TextWriter.)
Public methodWriteLineNoTabsWrites the specified string to a line without tabs.
Top

  NameDescription
Protected fieldCoreNewLineStores the newline characters used for this TextWriter. (Inherited from TextWriter.)
Public fieldStatic memberDefaultTabStringSpecifies the default tab string. This field is constant.
Top

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.

NoteNote

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.

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

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

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft