StringWriter Class

May 11, 2014

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)

public class StringWriter : TextWriter

The StringWriter type exposes the following members.

  NameDescription
Public methodStringWriter()Initializes a new instance of the StringWriter class.
Public methodStringWriter(IFormatProvider)Initializes a new instance of the StringWriter class with the specified format control.
Public methodStringWriter(StringBuilder)Initializes a new instance of the StringWriter class that writes to the specified StringBuilder.
Public methodStringWriter(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 propertyEncodingGets the Encoding in which the output is written. (Overrides TextWriter.Encoding.)
Public propertyFormatProviderGets an object that controls formatting. (Inherited from TextWriter.)
Public propertyNewLineGets or sets the line terminator string used by the current TextWriter. (Inherited from TextWriter.)
Top

  NameDescription
Public methodCloseCloses the current StringWriter and the underlying stream. (Overrides TextWriter.Close().)
Public methodDispose()Releases all resources used by the TextWriter object. (Inherited from TextWriter.)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the StringWriter and optionally releases the managed resources. (Overrides TextWriter.Dispose(Boolean).)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodFlushClears all buffers for the current writer and causes any buffered data to be written to the underlying device. (Inherited from TextWriter.)
Public methodFlushAsyncAsynchronously clears all buffers for the current writer and causes any buffered data to be written to the underlying device. (Overrides TextWriter.FlushAsync().)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetStringBuilderReturns the underlying StringBuilder.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string containing the characters written to the current StringWriter so far. (Overrides Object.ToString().)
Public methodWrite(Boolean)Writes the text representation of a Boolean value to the text stream. (Inherited from TextWriter.)
Public methodWrite(Char)Writes a character to this instance of the StringWriter. (Overrides TextWriter.Write(Char).)
Public methodWrite(Char[])Writes a character array to the text stream. (Inherited from TextWriter.)
Public methodWrite(Decimal)Writes the text representation of a decimal value to the text stream. (Inherited from TextWriter.)
Public methodWrite(Double)Writes the text representation of an 8-byte floating-point value to the text stream. (Inherited from TextWriter.)
Public methodWrite(Int32)Writes the text representation of a 4-byte signed integer to the text stream. (Inherited from TextWriter.)
Public methodWrite(Int64)Writes the text representation of an 8-byte signed integer to the text stream. (Inherited from TextWriter.)
Public methodWrite(Object)Writes the text representation of an object to the text stream by calling ToString on that object. (Inherited from TextWriter.)
Public methodWrite(Single)Writes the text representation of a 4-byte floating-point value to the text stream. (Inherited from TextWriter.)
Public methodWrite(String)Writes a string to this instance of the StringWriter. (Overrides TextWriter.Write(String).)
Public methodWrite(UInt32)Writes the text representation of a 4-byte unsigned integer to the text stream. (Inherited from TextWriter.)
Public methodWrite(UInt64)Writes the text representation of an 8-byte unsigned integer to the text stream. (Inherited from TextWriter.)
Public methodWrite(String, Object)Writes out a formatted string, using the same semantics as String.Format. (Inherited from TextWriter.)
Public methodWrite(String, Object[])Writes out a formatted string, using the same semantics as String.Format. (Inherited from TextWriter.)
Public methodWrite(Char[], Int32, Int32)Writes the specified region of a character array to this instance of the StringWriter. (Overrides TextWriter.Write(Char[], Int32, Int32).)
Public methodWrite(String, Object, Object)Writes out a formatted string, using the same semantics as String.Format. (Inherited from TextWriter.)
Public methodWriteAsync(Char)Writes a character to the string asynchronously. (Overrides TextWriter.WriteAsync(Char).)
Public methodWriteAsync(Char[])Writes a character array to the text string or stream asynchronously. (Inherited from TextWriter.)
Public methodWriteAsync(String)Writes a string to the current string asynchronously. (Overrides TextWriter.WriteAsync(String).)
Public methodWriteAsync(Char[], Int32, Int32)Writes a subarray of characters to the string asynchronously. (Overrides TextWriter.WriteAsync(Char[], Int32, Int32).)
Public methodWriteLine()Writes a line terminator to the text stream. (Inherited from TextWriter.)
Public methodWriteLine(Boolean)Writes the text representation of a Boolean followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodWriteLine(Char)Writes a character followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodWriteLine(Char[])Writes an array of characters followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodWriteLine(Decimal)Writes the text representation of a decimal value followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodWriteLine(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 methodWriteLine(Int32)Writes the text representation of a 4-byte signed integer followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodWriteLine(Int64)Writes the text representation of an 8-byte signed integer followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodWriteLine(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 methodWriteLine(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 methodWriteLine(String)Writes a string followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodWriteLine(UInt32)Writes the text representation of a 4-byte unsigned integer followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodWriteLine(UInt64)Writes the text representation of an 8-byte unsigned integer followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodWriteLine(String, Object)Writes out a formatted string and a new line, using the same semantics as Format. (Inherited from TextWriter.)
Public methodWriteLine(String, Object[])Writes out a formatted string and a new line, using the same semantics as Format. (Inherited from TextWriter.)
Public methodWriteLine(Char[], Int32, Int32)Writes a subarray of characters followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodWriteLine(String, Object, Object)Writes out a formatted string and a new line, using the same semantics as Format. (Inherited from TextWriter.)
Public methodWriteLineAsync()Writes a line terminator asynchronously to the text string or stream. (Inherited from TextWriter.)
Public methodWriteLineAsync(Char)Writes a character followed by a line terminator asynchronously to the string. (Overrides TextWriter.WriteLineAsync(Char).)
Public methodWriteLineAsync(Char[])Writes an array of characters followed by a line terminator asynchronously to the text string or stream. (Inherited from TextWriter.)
Public methodWriteLineAsync(String)Writes a string followed by a line terminator asynchronously to the current string. (Overrides TextWriter.WriteLineAsync(String).)
Public methodWriteLineAsync(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 fieldCoreNewLineStores the new line characters used for this TextWriter. (Inherited from TextWriter.)
Top

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

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