Export (0) Print
Expand All

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 LibrarySupported in .NET for Windows Store appsStringWriter()Initializes a new instance of the StringWriter class.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsStringWriter(IFormatProvider)Initializes a new instance of the StringWriter class with the specified format control.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsStringWriter(StringBuilder)Initializes a new instance of the StringWriter class that writes to the specified StringBuilder.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsStringWriter(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 LibrarySupported in .NET for Windows Store appsEncodingGets the Encoding in which the output is written. (Overrides TextWriter.Encoding.)
Public propertySupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsFormatProviderGets an object that controls formatting. (Inherited from TextWriter.)
Public propertySupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsNewLineGets 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 LibrarySupported in .NET for Windows Store appsDispose()Releases all resources used by the TextWriter object. (Inherited from TextWriter.)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsDispose(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 LibrarySupported in .NET for Windows Store appsEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsFinalizeAllows 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 LibrarySupported in .NET for Windows Store appsFlushClears all buffers for the current writer and causes any buffered data to be written to the underlying device. (Inherited from TextWriter.)
Public methodSupported in .NET for Windows Store appsFlushAsyncAsynchronously clears all buffers for the current writer and causes any buffered data to be written to the underlying device. (Overrides TextWriter.FlushAsync().)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetHashCodeServes 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 methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetStringBuilderReturns the underlying StringBuilder.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetTypeGets 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 LibrarySupported in .NET for Windows Store appsMemberwiseClone()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 LibrarySupported in .NET for Windows Store appsToStringReturns a string containing the characters written to the current StringWriter so far. (Overrides Object.ToString().)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(Boolean)Writes the text representation of a Boolean value to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(Char)Writes a character to the string. (Overrides TextWriter.Write(Char).)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(Char[])Writes a character array to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(Decimal)Writes the text representation of a decimal value to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(Double)Writes the text representation of an 8-byte floating-point value to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(Int32)Writes the text representation of a 4-byte signed integer to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(Int64)Writes the text representation of an 8-byte signed integer to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(Object)Writes the text representation of an object to the text string or stream by calling the ToString method on that object. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(Single)Writes the text representation of a 4-byte floating-point value to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(String)Writes a string to the current string. (Overrides TextWriter.Write(String).)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(UInt32)Writes the text representation of a 4-byte unsigned integer to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(UInt64)Writes the text representation of an 8-byte unsigned integer to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkWrite(String, Object)Writes a formatted string to the text string or stream, using the same semantics as the String.Format(String, Object) method. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(String, Object[])Writes a formatted string to the text string or stream, using the same semantics as the String.Format(String, Object[]) method. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(Char[], Int32, Int32)Writes a subarray of characters to the string. (Overrides TextWriter.Write(Char[], Int32, Int32).)
Public methodSupported by the XNA FrameworkWrite(String, Object, Object)Writes a formatted string to the text string or stream, using the same semantics as the String.Format(String, Object, Object) method. (Inherited from TextWriter.)
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 methodSupported in .NET for Windows Store appsWriteAsync(Char)Writes a character to the string asynchronously. (Overrides TextWriter.WriteAsync(Char).)
Public methodSupported in .NET for Windows Store appsWriteAsync(Char[])Writes a character array to the text string or stream asynchronously. (Inherited from TextWriter.)
Public methodSupported in .NET for Windows Store appsWriteAsync(String)Writes a string to the current string asynchronously. (Overrides TextWriter.WriteAsync(String).)
Public methodSupported in .NET for Windows Store appsWriteAsync(Char[], Int32, Int32)Writes a subarray of characters to the string asynchronously. (Overrides TextWriter.WriteAsync(Char[], Int32, Int32).)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine()Writes a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(Boolean)Writes the text representation of a Boolean value followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(Char)Writes a character followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(Char[])Writes an array of characters followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(Decimal)Writes the text representation of a decimal value followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(Double)Writes the text representation of a 8-byte floating-point value followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(Int32)Writes the text representation of a 4-byte signed integer followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(Int64)Writes the text representation of an 8-byte signed integer followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(Object)Writes the text representation of an object by calling the ToString method on that object, followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(Single)Writes the text representation of a 4-byte floating-point value followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(String)Writes a string followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(UInt32)Writes the text representation of a 4-byte unsigned integer followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(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 methodSupported by the XNA FrameworkWriteLine(String, Object)Writes a formatted string and a new line to the text string or stream, using the same semantics as the String.Format(String, Object) method. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(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 LibrarySupported in .NET for Windows Store appsWriteLine(Char[], Int32, Int32)Writes a subarray of characters followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkWriteLine(String, Object, Object)Writes a formatted string and a new line to the text string or stream, using the same semantics as the String.Format(String, Object, Object) method. (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.)
Public methodSupported in .NET for Windows Store appsWriteLineAsync()Writes a line terminator asynchronously to the text string or stream. (Inherited from TextWriter.)
Public methodSupported in .NET for Windows Store appsWriteLineAsync(Char)Writes a character followed by a line terminator asynchronously to the string. (Overrides TextWriter.WriteLineAsync(Char).)
Public methodSupported in .NET for Windows Store appsWriteLineAsync(Char[])Writes an array of characters followed by a line terminator asynchronously to the text string or stream. (Inherited from TextWriter.)
Public methodSupported in .NET for Windows Store appsWriteLineAsync(String)Writes a string followed by a line terminator asynchronously to the current string. (Overrides TextWriter.WriteLineAsync(String).)
Public methodSupported in .NET for Windows Store appsWriteLineAsync(Char[], Int32, Int32)Writes a subarray of characters followed by a line terminator asynchronously to the string. (Overrides TextWriter.WriteLineAsync(Char[], Int32, Int32).)
Top

  NameDescription
Protected fieldSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsCoreNewLineStores the newline characters used for this TextWriter. (Inherited from TextWriter.)
Top

StringWriter enables you to write to a string synchronously or asynchronously. You can write a character at a time with the Write(Char) or the WriteAsync(Char) method, a string at a time using the Write(String) or the WriteAsync(String) method. In addition, you can write a character, an array of characters or a string followed by the line terminator asynchronously with one of the WriteLineAsync methods.

Important noteImportant

This type implements the IDisposable interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its Dispose method in a try /catch block. To dispose of it indirectly, use a language construct such as using (in C#) or Using (in Visual Basic). For more information, see the “Using an Object that Implements IDisposable” section in the IDisposable interface topic.

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.5.2, 4.5.1, 4.5, 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

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, 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