Export (0) Print
Expand All
0 out of 3 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.

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

The StringWriter type exposes the following members.

  NameDescription
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryStringWriter()Initializes a new instance of the StringWriter class.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryStringWriter(IFormatProvider)Initializes a new instance of the StringWriter class with the specified format control.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryStringWriter(StringBuilder)Initializes a new instance of the StringWriter class that writes to the specified StringBuilder.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryStringWriter(StringBuilder, IFormatProvider)Initializes a new instance of the StringWriter class that writes to the specified StringBuilder and has the specified format provider.
Top
  NameDescription
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryEncodingGets the Encoding in which the output is written. (Overrides TextWriter.Encoding.)
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryFormatProviderGets an object that controls formatting. (Inherited from TextWriter.)
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryNewLineGets or sets the line terminator string used by the current TextWriter. (Inherited from TextWriter.)
Top
  NameDescription
Public methodSupported by the XNA FrameworkCloseCloses the current StringWriter and the underlying stream. (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 methodSupported by the XNA FrameworkSupported by Portable Class LibraryDispose()Releases all resources used by the TextWriter object. (Inherited from TextWriter.)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibraryDispose(Boolean)Releases the unmanaged resources used by the StringWriter and optionally releases the managed resources. (Overrides TextWriter.Dispose(Boolean).)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibraryFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryFlushClears all buffers for the current writer and causes any buffered data to be written to the underlying device. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryGetStringBuilderReturns the underlying StringBuilder.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryGetTypeGets 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 methodSupported by the XNA FrameworkSupported by Portable Class LibraryMemberwiseClone()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.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryToStringReturns a string containing the characters written to the current StringWriter so far. (Overrides Object.ToString().)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Boolean)Writes the text representation of a Boolean value to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Char)Writes a character to this instance of the StringWriter. (Overrides TextWriter.Write(Char).)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Char[])Writes a character array to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Decimal)Writes the text representation of a decimal value to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Double)Writes the text representation of an 8-byte floating-point value to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Int32)Writes the text representation of a 4-byte signed integer to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Int64)Writes the text representation of an 8-byte signed integer to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Object)Writes the text representation of an object to the text stream by calling ToString on that object. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Single)Writes the text representation of a 4-byte floating-point value to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(String)Writes a string to this instance of the StringWriter. (Overrides TextWriter.Write(String).)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(UInt32)Writes the text representation of a 4-byte unsigned integer to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(UInt64)Writes the text representation of an 8-byte unsigned integer to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkWrite(String, Object)Writes out a formatted string, using the same semantics as String.Format. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(String, Object[])Writes out a formatted string, using the same semantics as String.Format. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Char[], Int32, Int32)Writes the specified region of a character array to this instance of the StringWriter. (Overrides TextWriter.Write(Char[], Int32, Int32).)
Public methodSupported by the XNA FrameworkWrite(String, Object, Object)Writes out a formatted string, using the same semantics as String.Format. (Inherited from TextWriter.)
Public methodWrite(String, Object, Object, Object)Writes out a formatted string, using the same semantics as String.Format. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine()Writes a line terminator to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine(Boolean)Writes the text representation of a Boolean followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine(Char)Writes a character followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine(Char[])Writes an array of characters followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine(Decimal)Writes the text representation of a decimal value followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine(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 methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine(Int32)Writes the text representation of a 4-byte signed integer followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine(Int64)Writes the text representation of an 8-byte signed integer followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine(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 methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine(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 methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine(String)Writes a string followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine(UInt32)Writes the text representation of a 4-byte unsigned integer followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine(UInt64)Writes the text representation of an 8-byte unsigned integer followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkWriteLine(String, Object)Writes out a formatted string and a new line, using the same semantics as Format. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine(String, Object[])Writes out a formatted string and a new line, using the same semantics as Format. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine(Char[], Int32, Int32)Writes a subarray of characters followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkWriteLine(String, Object, Object)Writes out a formatted string and a new line, using the same semantics as Format. (Inherited from TextWriter.)
Public methodWriteLine(String, Object, Object, Object)Writes out a formatted string and a new line, using the same semantics as Format. (Inherited from TextWriter.)
Top
  NameDescription
Protected fieldSupported by the XNA FrameworkSupported by Portable Class LibraryCoreNewLineStores 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)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.