StringWriter Class
Implements a TextWriter for writing information to a string. The information is stored in an underlying StringBuilder.
Assembly: mscorlib (in mscorlib.dll)
The StringWriter type exposes the following members.
| Name | Description | |
|---|---|---|
![]() ![]() ![]() | StringWriter | Initializes a new instance of the StringWriter class. |
![]() ![]() ![]() | StringWriter(IFormatProvider) | Initializes a new instance of the StringWriter class with the specified format control. |
![]() ![]() ![]() | StringWriter(StringBuilder) | Initializes a new instance of the StringWriter class that writes to the specified StringBuilder. |
![]() ![]() ![]() | StringWriter(StringBuilder, IFormatProvider) | Initializes a new instance of the StringWriter class that writes to the specified StringBuilder and has the specified format provider. |
| Name | Description | |
|---|---|---|
![]() ![]() ![]() | Encoding | Gets the Encoding in which the output is written. (Overrides TextWriter.Encoding.) |
![]() ![]() ![]() | FormatProvider | Gets an object that controls formatting. (Inherited from TextWriter.) |
![]() ![]() ![]() | NewLine | Gets or sets the line terminator string used by the current TextWriter. (Inherited from TextWriter.) |
| Name | Description | |
|---|---|---|
![]() ![]() | Close | Closes the current StringWriter and the underlying stream. (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 StringWriter and optionally releases the managed resources. (Overrides TextWriter.Dispose(Boolean).) |
![]() ![]() ![]() | 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 | Clears all buffers for the current writer and causes any buffered data to be written to the underlying device. (Inherited from TextWriter.) |
![]() ![]() ![]() | 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.) |
![]() ![]() ![]() | GetStringBuilder | Returns the underlying StringBuilder. |
![]() ![]() ![]() | 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.) |
![]() ![]() ![]() | ToString | Returns a string containing the characters written to the current StringWriter so far. (Overrides Object.ToString.) |
![]() ![]() ![]() | Write(Boolean) | Writes the text representation of a Boolean value to the text stream. (Inherited from TextWriter.) |
![]() ![]() ![]() | Write(Char) | Writes a character to this instance of the StringWriter. (Overrides TextWriter.Write(Char).) |
![]() ![]() ![]() | Write(Char()) | Writes a character array to the text stream. (Inherited from TextWriter.) |
![]() ![]() ![]() | Write(Decimal) | Writes the text representation of a decimal value to the text stream. (Inherited from TextWriter.) |
![]() ![]() ![]() | Write(Double) | Writes the text representation of an 8-byte floating-point value to the text stream. (Inherited from TextWriter.) |
![]() ![]() ![]() | Write(Int32) | Writes the text representation of a 4-byte signed integer to the text stream. (Inherited from TextWriter.) |
![]() ![]() ![]() | Write(Int64) | Writes the text representation of an 8-byte signed integer to the text stream. (Inherited from TextWriter.) |
![]() ![]() ![]() | Write(Object) | Writes the text representation of an object to the text stream by calling ToString on that object. (Inherited from TextWriter.) |
![]() ![]() ![]() | Write(Single) | Writes the text representation of a 4-byte floating-point value to the text stream. (Inherited from TextWriter.) |
![]() ![]() ![]() | Write(String) | Writes a string to this instance of the StringWriter. (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 String.Format. (Inherited from TextWriter.) |
![]() ![]() ![]() | Write(String, Object()) | Writes out a formatted string, using the same semantics as String.Format. (Inherited from TextWriter.) |
![]() ![]() ![]() | Write(Char(), Int32, Int32) | Writes the specified region of a character array to this instance of the StringWriter. (Overrides TextWriter.Write(Char(), Int32, Int32).) |
![]() ![]() | Write(String, Object, Object) | Writes out a formatted string, using the same semantics as String.Format. (Inherited from TextWriter.) |
![]() | 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 to the text stream. (Inherited from TextWriter.) |
![]() ![]() ![]() | WriteLine(Boolean) | Writes the text representation of a Boolean followed by a line terminator to the text stream. (Inherited from TextWriter.) |
![]() ![]() ![]() | WriteLine(Char) | Writes a character followed by a line terminator to the text stream. (Inherited from TextWriter.) |
![]() ![]() ![]() | WriteLine(Char()) | Writes an array of characters followed by a line terminator to the text stream. (Inherited from TextWriter.) |
![]() ![]() ![]() | 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 8-byte floating-point value followed by a line terminator to the text stream. (Inherited from TextWriter.) |
![]() ![]() ![]() | WriteLine(Int32) | Writes the text representation of a 4-byte signed integer followed by a line terminator to the text stream. (Inherited from TextWriter.) |
![]() ![]() ![]() | WriteLine(Int64) | Writes the text representation of an 8-byte signed integer followed by a line terminator to the text stream. (Inherited from TextWriter.) |
![]() ![]() ![]() | 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.) |
![]() ![]() ![]() | 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.) |
![]() ![]() ![]() | WriteLine(String) | Writes a string followed by a line terminator to the text stream. (Inherited from TextWriter.) |
![]() ![]() ![]() | WriteLine(UInt32) | Writes the text representation of a 4-byte unsigned integer followed by a line terminator to the text stream. (Inherited from TextWriter.) |
![]() ![]() ![]() | 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 and a new line, using the same semantics as Format. (Inherited from TextWriter.) |
![]() ![]() ![]() | WriteLine(String, Object()) | Writes out a formatted string and a new line, using the same semantics as Format. (Inherited from TextWriter.) |
![]() ![]() ![]() | WriteLine(Char(), Int32, Int32) | Writes a subarray of characters followed by a line terminator to the text stream. (Inherited from TextWriter.) |
![]() ![]() | WriteLine(String, Object, Object) | Writes out a formatted string and a new line, using the same semantics as Format. (Inherited from TextWriter.) |
![]() | WriteLine(String, Object, Object, Object) | Writes out a formatted string and a new line, using the same semantics as Format. (Inherited from TextWriter.) |
| Name | Description | |
|---|---|---|
![]() ![]() ![]() | CoreNewLine | Stores the new line characters used for this TextWriter. (Inherited from TextWriter.) |
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. | |
Write to a text file. | |
Read from a text file. | |
Append text to a file. | |
Get the size of a file. | |
Get the attributes of a file. | |
Set the attributes of a file. | |
Determine if a file exists. | |
Read from a binary file. | |
Write to a binary 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.
Option Explicit Option Strict Imports Microsoft.VisualBasic Imports System Imports System.IO Public Class StrReader Shared Sub Main() Dim textReaderText As String = "TextReader is the " & _ "abstract base class of StreamReader and " & _ "StringReader, which read characters from streams " & _ "and strings, respectively." & _ vbCrLf & vbCrLf & _ "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." & _ vbCrLf & vbCrLf & _ "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." & _ vbCrLf & vbCrLf Console.WriteLine("Original text:" & vbCrLf & vbCrLf & _ textReaderText) ' From textReaderText, create a continuous paragraph ' with two spaces between each sentence. Dim aLine, aParagraph As String Dim strReader As New StringReader(textReaderText) While True aLine = strReader.ReadLine() If aLine Is Nothing Then aParagraph = aParagraph & vbCrLf Exit While Else aParagraph = aParagraph & aLine & " " End If End While Console.WriteLine("Modified text:" & vbCrLf & vbCrLf & _ aParagraph) ' Re-create textReaderText from aParagraph. Dim intCharacter As Integer Dim convertedCharacter As Char Dim strWriter As 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 Then Exit While End If convertedCharacter = Convert.ToChar(intCharacter) If convertedCharacter = "."C Then strWriter.Write("." & vbCrLf & vbCrLf) ' Bypass the spaces between sentences. strReader.Read() strReader.Read() Else strWriter.Write(convertedCharacter) End If End While Console.WriteLine(vbCrLf & "Original text:" & vbCrLf & _ vbCrLf & strWriter.ToString()) End Sub End Class
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.

