Article
11/18/2011

StringWriter Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

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

Inheritance Hierarchy

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

Namespace: System.IO
Assembly: mscorlib (in mscorlib.dll)

Syntax

'Declaration
<ComVisibleAttribute(True)> _
Public Class StringWriter _
    Inherits TextWriter

[ComVisibleAttribute(true)]
public class StringWriter : TextWriter

The StringWriter type exposes the following members.

Constructors

	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.

Top

Properties

	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.)

Top

Methods

	Name	Description
	Close	Closes the current StringWriter and the underlying stream. (Overrides TextWriter.Close().)
	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 the Object 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.)
	GetStringBuilder	Returns the underlying StringBuilder.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	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(array<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, array<Object[])	Writes out a formatted string, using the same semantics as String.Format. (Inherited from TextWriter.)
	Write(array<Char[], Int32, Int32)	Writes the specified region of a character array to this instance of the StringWriter. (Overrides TextWriter.Write(array<Char[], Int32, Int32).)
	Write(String, 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(array<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, array<Object[])	Writes out a formatted string and a new line, using the same semantics as Format. (Inherited from TextWriter.)
	WriteLine(array<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.)

Top

Fields

	Name	Description
	CoreNewLine	Stores the new line characters used for this TextWriter. (Inherited from TextWriter.)

Top

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Partager via