0 out of 1 rated this helpful - Rate this topic

StringWriter Class

Implements a TextWriter for writing information to a string. The information is stored in an underlying StringBuilder.

System.Object
  System.MarshalByRefObject
    System.IO.TextWriter
      System.IO.StringWriter

Namespace:  System.IO
Assembly:  mscorlib (in mscorlib.dll)
[SerializableAttribute]
[ComVisibleAttribute(true)]
public class StringWriter : TextWriter

The StringWriter type exposes the following members.

  Name Description
Public method Supported by the XNA Framework Supported by Portable Class Library StringWriter() Initializes a new instance of the StringWriter class.
Public method Supported by the XNA Framework Supported by Portable Class Library StringWriter(IFormatProvider) Initializes a new instance of the StringWriter class with the specified format control.
Public method Supported by the XNA Framework Supported by Portable Class Library StringWriter(StringBuilder) Initializes a new instance of the StringWriter class that writes to the specified StringBuilder.
Public method Supported by the XNA Framework Supported by Portable Class Library StringWriter(StringBuilder, IFormatProvider) Initializes a new instance of the StringWriter class that writes to the specified StringBuilder and has the specified format provider.
Top
  Name Description
Public property Supported by the XNA Framework Supported by Portable Class Library Encoding Gets the Encoding in which the output is written. (Overrides TextWriter.Encoding.)
Public property Supported by the XNA Framework Supported by Portable Class Library FormatProvider Gets an object that controls formatting. (Inherited from TextWriter.)
Public property Supported by the XNA Framework Supported by Portable Class Library NewLine Gets or sets the line terminator string used by the current TextWriter. (Inherited from TextWriter.)
Top
  Name Description
Public method Supported by the XNA Framework Close Closes the current StringWriter and the underlying stream. (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 Supported by the XNA Framework Supported by Portable Class Library Dispose() Releases all resources used by the TextWriter object. (Inherited from TextWriter.)
Protected method Supported by the XNA Framework Supported by Portable Class Library Dispose(Boolean) Releases the unmanaged resources used by the StringWriter and optionally releases the managed resources. (Overrides TextWriter.Dispose(Boolean).)
Public method Supported by the XNA Framework Supported by Portable Class Library Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Supported by the XNA Framework Supported by Portable Class Library 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 Supported by the XNA Framework Supported by Portable Class Library Flush Clears all buffers for the current writer and causes any buffered data to be written to the underlying device. (Inherited from TextWriter.)
Public method Supported by the XNA Framework Supported by Portable Class Library 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 Supported by the XNA Framework Supported by Portable Class Library GetStringBuilder Returns the underlying StringBuilder.
Public method Supported by the XNA Framework Supported by Portable Class Library 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 Supported by the XNA Framework Supported by Portable Class Library 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.)
Public method Supported by the XNA Framework Supported by Portable Class Library ToString Returns a string containing the characters written to the current StringWriter so far. (Overrides Object.ToString().)
Public method Supported by the XNA Framework Supported by Portable Class Library Write(Boolean) Writes the text representation of a Boolean value to the text stream. (Inherited from TextWriter.)
Public method Supported by the XNA Framework Supported by Portable Class Library Write(Char) Writes a character to this instance of the StringWriter. (Overrides TextWriter.Write(Char).)
Public method Supported by the XNA Framework Supported by Portable Class Library Write(Char[]) Writes a character array to the text stream. (Inherited from TextWriter.)
Public method Supported by the XNA Framework Supported by Portable Class Library Write(Decimal) Writes the text representation of a decimal value to the text stream. (Inherited from TextWriter.)
Public method Supported by the XNA Framework Supported by Portable Class Library Write(Double) Writes the text representation of an 8-byte floating-point value to the text stream. (Inherited from TextWriter.)
Public method Supported by the XNA Framework Supported by Portable Class Library Write(Int32) Writes the text representation of a 4-byte signed integer to the text stream. (Inherited from TextWriter.)
Public method Supported by the XNA Framework Supported by Portable Class Library Write(Int64) Writes the text representation of an 8-byte signed integer to the text stream. (Inherited from TextWriter.)
Public method Supported by the XNA Framework Supported by Portable Class Library Write(Object) Writes the text representation of an object to the text stream by calling ToString on that object. (Inherited from TextWriter.)
Public method Supported by the XNA Framework Supported by Portable Class Library Write(Single) Writes the text representation of a 4-byte floating-point value to the text stream. (Inherited from TextWriter.)
Public method Supported by the XNA Framework Supported by Portable Class Library Write(String) Writes a string to this instance of the StringWriter. (Overrides TextWriter.Write(String).)
Public method Supported by the XNA Framework Supported by Portable Class Library Write(UInt32) Writes the text representation of a 4-byte unsigned integer to the text stream. (Inherited from TextWriter.)
Public method Supported by the XNA Framework Supported by Portable Class Library Write(UInt64) Writes the text representation of an 8-byte unsigned integer to the text stream. (Inherited from TextWriter.)
Public method Supported by the XNA Framework Write(String, Object) Writes out a formatted string, using the same semantics as String.Format. (Inherited from TextWriter.)
Public method Supported by the XNA Framework Supported by Portable Class Library Write(String, Object[]) Writes out a formatted string, using the same semantics as String.Format. (Inherited from TextWriter.)
Public method Supported by the XNA Framework Supported by Portable Class Library Write(Char[], Int32, Int32) Writes the specified region of a character array to this instance of the StringWriter. (Overrides TextWriter.Write(Char[], Int32, Int32).)
Public method Supported by the XNA Framework Write(String, Object, Object) Writes out a formatted string, using the same semantics as String.Format. (Inherited from TextWriter.)
Public method Write(String, Object, Object, Object) Writes out a formatted string, using the same semantics as String.Format. (Inherited from TextWriter.)
Public method Supported by the XNA Framework Supported by Portable Class Library WriteLine() Writes a line terminator to the text stream. (Inherited from TextWriter.)
Public method Supported by the XNA Framework Supported by Portable Class Library WriteLine(Boolean) Writes the text representation of a Boolean followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public method Supported by the XNA Framework Supported by Portable Class Library WriteLine(Char) Writes a character followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public method Supported by the XNA Framework Supported by Portable Class Library WriteLine(Char[]) Writes an array of characters followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public method Supported by the XNA Framework Supported by Portable Class Library WriteLine(Decimal) Writes the text representation of a decimal value followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public method Supported by the XNA Framework Supported by Portable Class Library WriteLine(Double) Writes the text representation of a 8-byte floating-point value followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public method Supported by the XNA Framework Supported by Portable Class Library WriteLine(Int32) Writes the text representation of a 4-byte signed integer followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public method Supported by the XNA Framework Supported by Portable Class Library WriteLine(Int64) Writes the text representation of an 8-byte signed integer followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public method Supported by the XNA Framework Supported by Portable Class Library WriteLine(Object) Writes the text representation of an object by calling ToString on this object, followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public method Supported by the XNA Framework Supported by Portable Class Library WriteLine(Single) Writes the text representation of a 4-byte floating-point value followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public method Supported by the XNA Framework Supported by Portable Class Library WriteLine(String) Writes a string followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public method Supported by the XNA Framework Supported by Portable Class Library WriteLine(UInt32) Writes the text representation of a 4-byte unsigned integer followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public method Supported by the XNA Framework Supported by Portable Class Library 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 Supported by the XNA Framework WriteLine(String, Object) Writes out a formatted string and a new line, using the same semantics as Format. (Inherited from TextWriter.)
Public method Supported by the XNA Framework Supported by Portable Class Library WriteLine(String, Object[]) Writes out a formatted string and a new line, using the same semantics as Format. (Inherited from TextWriter.)
Public method Supported by the XNA Framework Supported by Portable Class Library WriteLine(Char[], Int32, Int32) Writes a subarray of characters followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public method Supported by the XNA Framework WriteLine(String, Object, Object) Writes out a formatted string and a new line, using the same semantics as Format. (Inherited from TextWriter.)
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.)
Top
  Name Description
Protected field Supported by the XNA Framework Supported by Portable Class Library CoreNewLine Stores the new line characters used for this TextWriter. (Inherited from TextWriter.)
Top

The following table lists examples of other typical or related I/O tasks.

To do this...

See the example in this topic...

Create a text file.

How to: Write Text to a File

Write to a text file.

How to: Write Text to a File

Read from a text file.

How to: Read Text from a File

Append text to a file.

How to: Open and Append to a Log File

File.AppendText

FileInfo.AppendText

Get the size of a file.

FileInfo.Length

Get the attributes of a file.

File.GetAttributes

Set the attributes of a file.

File.SetAttributes

Determine if a file exists.

File.Exists

Read from a binary file.

How to: Read and Write to a Newly Created Data File

Write to a binary file.

How to: Read and Write to a Newly Created Data File

The following code example demonstrates the creation of a continuous paragraph from a group of double-spaced sentences, and then the conversion of the paragraph back to the original text.


using System;
using System.IO;

class StringRW
{
    static void Main()
    {
        string textReaderText = "TextReader is the abstract base " +
            "class of StreamReader and StringReader, which read " +
            "characters from streams and strings, respectively.\n\n" +

            "Create an instance of TextReader to open a text file " +
            "for reading a specified range of characters, or to " +
            "create a reader based on an existing stream.\n\n" +

            "You can also use an instance of TextReader to read " +
            "text from a custom backing store using the same " +
            "APIs you would use for a string or a stream.\n\n";

        Console.WriteLine("Original text:\n\n{0}", textReaderText);

        // From textReaderText, create a continuous paragraph 
        // with two spaces between each sentence.
        string aLine, aParagraph = null;
        StringReader strReader = new StringReader(textReaderText);
        while(true)
        {
            aLine = strReader.ReadLine();
            if(aLine != null)
            {
                aParagraph = aParagraph + aLine + " ";
            }
            else
            {
                aParagraph = aParagraph + "\n";
                break;
            }
        }
        Console.WriteLine("Modified text:\n\n{0}", aParagraph);

        // Re-create textReaderText from aParagraph.
        int intCharacter;
        char convertedCharacter;
        StringWriter strWriter = new StringWriter();
        strReader = new StringReader(aParagraph);
        while(true)
        {
            intCharacter = strReader.Read();

            // Check for the end of the string 
            // before converting to a character.
            if(intCharacter == -1) break;

            convertedCharacter = Convert.ToChar(intCharacter);
            if(convertedCharacter == '.')
            {
                strWriter.Write(".\n\n");

                // Bypass the spaces between sentences.
                strReader.Read();
                strReader.Read();
            }
            else
            {
                strWriter.Write(convertedCharacter);
            }
        }
        Console.WriteLine("\nOriginal text:\n\n{0}", 
            strWriter.ToString());
    }
}


.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

Portable Class Library

Supported in: Portable Class Library

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.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ