TextWriter Class

Inheritance Hierarchy

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

Syntax

'Declaration
<ComVisibleAttribute(True)> _
Public MustInherit Class TextWriter _
    Implements IDisposable

[ComVisibleAttribute(true)]
public abstract class TextWriter : IDisposable

Constructors

	Name	Description
	TextWriter()	Initializes a new instance of the TextWriter class.
	TextWriter(IFormatProvider)	Initializes a new instance of the TextWriter class with the specified format provider.

Top

Properties

	Name	Description
	Encoding	When overridden in a derived class, returns the Encoding in which the output is written.
	FormatProvider	Gets an object that controls formatting.
	NewLine	Gets or sets the line terminator string used by the current TextWriter.

Top

Methods

	Name	Description
	Close	Closes the current writer and releases any system resources associated with the writer.
	Dispose()	Releases all resources used by the TextWriter object.
	Dispose(Boolean)	Releases the unmanaged resources used by the TextWriter and optionally releases the managed resources.
	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.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	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 that represents the current object. (Inherited from Object.)
	Write(Boolean)	Writes the text representation of a Boolean value to the text stream.
	Write(Char)	Writes a character to the text stream.
	Write(array<Char[])	Writes a character array to the text stream.
	Write(Decimal)	Writes the text representation of a decimal value to the text stream.
	Write(Double)	Writes the text representation of an 8-byte floating-point value to the text stream.
	Write(Int32)	Writes the text representation of a 4-byte signed integer to the text stream.
	Write(Int64)	Writes the text representation of an 8-byte signed integer to the text stream.
	Write(Object)	Writes the text representation of an object to the text stream by calling ToString on that object.
	Write(Single)	Writes the text representation of a 4-byte floating-point value to the text stream.
	Write(String)	Writes a string to the text stream.
	Write(UInt32)	Writes the text representation of a 4-byte unsigned integer to the text stream.
	Write(UInt64)	Writes the text representation of an 8-byte unsigned integer to the text stream.
	Write(String, Object)	Writes out a formatted string, using the same semantics as String.Format.
	Write(String, array<Object[])	Writes out a formatted string, using the same semantics as String.Format.
	Write(array<Char[], Int32, Int32)	Writes a subarray of characters to the text stream.
	Write(String, Object, Object)	Writes out a formatted string, using the same semantics as String.Format.
	WriteLine()	Writes a line terminator to the text stream.
	WriteLine(Boolean)	Writes the text representation of a Boolean followed by a line terminator to the text stream.
	WriteLine(Char)	Writes a character followed by a line terminator to the text stream.
	WriteLine(array<Char[])	Writes an array of characters followed by a line terminator to the text stream.
	WriteLine(Decimal)	Writes the text representation of a decimal value followed by a line terminator to the text stream.
	WriteLine(Double)	Writes the text representation of a 8-byte floating-point value followed by a line terminator to the text stream.
	WriteLine(Int32)	Writes the text representation of a 4-byte signed integer followed by a line terminator to the text stream.
	WriteLine(Int64)	Writes the text representation of an 8-byte signed integer followed by a line terminator to the text stream.
	WriteLine(Object)	Writes the text representation of an object by calling ToString on this object, followed by a line terminator to the text stream.
	WriteLine(Single)	Writes the text representation of a 4-byte floating-point value followed by a line terminator to the text stream.
	WriteLine(String)	Writes a string followed by a line terminator to the text stream.
	WriteLine(UInt32)	Writes the text representation of a 4-byte unsigned integer followed by a line terminator to the text stream.
	WriteLine(UInt64)	Writes the text representation of an 8-byte unsigned integer followed by a line terminator to the text stream.
	WriteLine(String, Object)	Writes out a formatted string and a new line, using the same semantics as Format.
	WriteLine(String, array<Object[])	Writes out a formatted string and a new line, using the same semantics as Format.
	WriteLine(array<Char[], Int32, Int32)	Writes a subarray of characters followed by a line terminator to the text stream.
	WriteLine(String, Object, Object)	Writes out a formatted string and a new line, using the same semantics as Format.

Top

Fields

	Name	Description
	CoreNewLine	Stores the new line characters used for this TextWriter.
	Null	Provides a TextWriter with no backing store that can be written to, but not read from.

Top

Remarks

TextWriter is the abstract base class of StreamWriter and StringWriter, which write characters to streams and strings, respectively. Create an instance of TextWriter to write an object to a string, write strings to a file, or to serialize XML. You can also use an instance of TextWriter to write text to a custom backing store using the same APIs you would use for a string or a stream, or to add support for text formatting.

All the Write methods of TextWriter having primitive data types as parameters write out the values as strings.

Notes to Inheritors

A derived class must minimally implement the Write method to make a useful instance of TextWriter.

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.

See Also

Reference