IndentedTextWriter Class
Provides a text writer that can indent new lines by a tab string token.
System::MarshalByRefObject
System.IO::TextWriter
System.CodeDom.Compiler::IndentedTextWriter
Assembly: System (in System.dll)
The IndentedTextWriter type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | IndentedTextWriter(TextWriter) | Initializes a new instance of the IndentedTextWriter class using the specified text writer and default tab string. |
![]() | IndentedTextWriter(TextWriter, String) | Initializes a new instance of the IndentedTextWriter class using the specified text writer and tab string. |
| Name | Description | |
|---|---|---|
![]() | Encoding | Gets the encoding for the text writer to use. (Overrides TextWriter::Encoding.) |
![]() | FormatProvider | Gets an object that controls formatting. (Inherited from TextWriter.) |
![]() | Indent | Gets or sets the number of spaces to indent. |
![]() | InnerWriter | Gets the TextWriter to use. |
![]() | NewLine | Gets or sets the new line character to use. (Overrides TextWriter::NewLine.) |
| Name | Description | |
|---|---|---|
![]() | Close | Closes the document being written to. (Overrides TextWriter::Close().) |
![]() | 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.) |
![]() | Dispose() | Releases all resources used by the TextWriter object. (Inherited from TextWriter.) |
![]() | Dispose(Boolean) | Releases the unmanaged resources used by the TextWriter and optionally releases the managed resources. (Inherited from TextWriter.) |
![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | Flush | Flushes the stream. (Overrides TextWriter::Flush().) |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
![]() | MemberwiseClone() | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
![]() | OutputTabs | Outputs the tab string once for each level of indentation according to the Indent property. |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() | Write(Boolean) | Writes the text representation of a Boolean value to the text stream. (Overrides TextWriter::Write(Boolean).) |
![]() | Write(Char) | Writes a character to the text stream. (Overrides TextWriter::Write(Char).) |
![]() | Write(array<Char>) | Writes a character array to the text stream. (Overrides TextWriter::Write(array<Char>).) |
![]() | Write(Decimal) | Writes the text representation of a decimal value to the text stream. (Inherited from TextWriter.) |
![]() | Write(Double) | Writes the text representation of a Double to the text stream. (Overrides TextWriter::Write(Double).) |
![]() | Write(Int32) | Writes the text representation of an integer to the text stream. (Overrides TextWriter::Write(Int32).) |
![]() | Write(Int64) | Writes the text representation of an 8-byte integer to the text stream. (Overrides TextWriter::Write(Int64).) |
![]() | Write(Object) | Writes the text representation of an object to the text stream. (Overrides TextWriter::Write(Object).) |
![]() | Write(Single) | Writes the text representation of a Single to the text stream. (Overrides TextWriter::Write(Single).) |
![]() | Write(String) | Writes the specified string to the text stream. (Overrides TextWriter::Write(String).) |
![]() | Write(UInt32) | Writes the text representation of a 4-byte unsigned integer to the text stream. (Inherited from TextWriter.) |
![]() | Write(UInt64) | Writes the text representation of an 8-byte unsigned integer to the text stream. (Inherited from TextWriter.) |
![]() | Write(String, Object) | Writes out a formatted string, using the same semantics as specified. (Overrides TextWriter::Write(String, Object).) |
![]() | Write(String, array<Object>) | Writes out a formatted string, using the same semantics as specified. (Overrides TextWriter::Write(String, array<Object>).) |
![]() | Write(array<Char>, Int32, Int32) | Writes a subarray of characters to the text stream. (Overrides TextWriter::Write(array<Char>, Int32, Int32).) |
![]() | Write(String, Object, Object) | Writes out a formatted string, using the same semantics as specified. (Overrides TextWriter::Write(String, Object, Object).) |
![]() | Write(String, Object, Object, Object) | Writes out a formatted string, using the same semantics as String::Format. (Inherited from TextWriter.) |
![]() | WriteLine() | Writes a line terminator. (Overrides TextWriter::WriteLine().) |
![]() | WriteLine(Boolean) | Writes the text representation of a Boolean, followed by a line terminator, to the text stream. (Overrides TextWriter::WriteLine(Boolean).) |
![]() | WriteLine(Char) | Writes a character, followed by a line terminator, to the text stream. (Overrides TextWriter::WriteLine(Char).) |
![]() | WriteLine(array<Char>) | Writes a character array, followed by a line terminator, to the text stream. (Overrides TextWriter::WriteLine(array<Char>).) |
![]() | WriteLine(Decimal) | Writes the text representation of a decimal value followed by a line terminator to the text stream. (Inherited from TextWriter.) |
![]() | WriteLine(Double) | Writes the text representation of a Double, followed by a line terminator, to the text stream. (Overrides TextWriter::WriteLine(Double).) |
![]() | WriteLine(Int32) | Writes the text representation of an integer, followed by a line terminator, to the text stream. (Overrides TextWriter::WriteLine(Int32).) |
![]() | WriteLine(Int64) | Writes the text representation of an 8-byte integer, followed by a line terminator, to the text stream. (Overrides TextWriter::WriteLine(Int64).) |
![]() | WriteLine(Object) | Writes the text representation of an object, followed by a line terminator, to the text stream. (Overrides TextWriter::WriteLine(Object).) |
![]() | WriteLine(Single) | Writes the text representation of a Single, followed by a line terminator, to the text stream. (Overrides TextWriter::WriteLine(Single).) |
![]() | WriteLine(String) | Writes the specified string, followed by a line terminator, to the text stream. (Overrides TextWriter::WriteLine(String).) |
![]() | WriteLine(UInt32) | Writes the text representation of a UInt32, followed by a line terminator, to the text stream. (Overrides TextWriter::WriteLine(UInt32).) |
![]() | WriteLine(UInt64) | Writes the text representation of an 8-byte unsigned integer followed by a line terminator to the text stream. (Inherited from TextWriter.) |
![]() | WriteLine(String, Object) | Writes out a formatted string, followed by a line terminator, using the same semantics as specified. (Overrides TextWriter::WriteLine(String, Object).) |
![]() | WriteLine(String, array<Object>) | Writes out a formatted string, followed by a line terminator, using the same semantics as specified. (Overrides TextWriter::WriteLine(String, array<Object>).) |
![]() | WriteLine(array<Char>, Int32, Int32) | Writes a subarray of characters, followed by a line terminator, to the text stream. (Overrides TextWriter::WriteLine(array<Char>, Int32, Int32).) |
![]() | 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).) |
![]() | WriteLine(String, Object, Object, Object) | Writes out a formatted string and a new line, using the same semantics as Format. (Inherited from TextWriter.) |
![]() | WriteLineNoTabs | Writes the specified string to a line without tabs. |
| Name | Description | |
|---|---|---|
![]() | CoreNewLine | Stores the new line characters used for this TextWriter. (Inherited from TextWriter.) |
![]() ![]() | DefaultTabString | Specifies the default tab string. This field is constant. |
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 |
|---|
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.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 ); }
- SecurityAction::LinkDemand
for full trust for the immediate caller. This class cannot be used by partially trusted code.
- SecurityAction::InheritanceDemand
for full trust for inheritors. This class cannot be inherited by partially trusted code.
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.
