TextWriter Class

May 11, 2014

Represents a writer that can write a sequential series of characters. This class is abstract.

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

public abstract class TextWriter : IDisposable

The TextWriter type exposes the following members.

  NameDescription
Protected methodTextWriter()Initializes a new instance of the TextWriter class.
Protected methodTextWriter(IFormatProvider)Initializes a new instance of the TextWriter class with the specified format provider.
Top

  NameDescription
Public propertyEncodingWhen overridden in a derived class, returns the Encoding in which the output is written.
Public propertyFormatProviderGets an object that controls formatting.
Public propertyNewLineGets or sets the line terminator string used by the current TextWriter.
Top

  NameDescription
Public methodCloseCloses the current writer and releases any system resources associated with the writer.
Public methodDispose()Releases all resources used by the TextWriter object.
Protected methodDispose(Boolean)Releases the unmanaged resources used by the TextWriter and optionally releases the managed resources.
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.
Public methodFlushAsyncAsynchronously clears all buffers for the current writer and causes any buffered data to be written to the underlying device.
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
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 that represents the current object. (Inherited from Object.)
Public methodWrite(Boolean)Writes the text representation of a Boolean value to the text stream.
Public methodWrite(Char)Writes a character to the text stream.
Public methodWrite(Char[])Writes a character array to the text stream.
Public methodWrite(Decimal)Writes the text representation of a decimal value to the text stream.
Public methodWrite(Double)Writes the text representation of an 8-byte floating-point value to the text stream.
Public methodWrite(Int32)Writes the text representation of a 4-byte signed integer to the text stream.
Public methodWrite(Int64)Writes the text representation of an 8-byte signed integer to the text stream.
Public methodWrite(Object)Writes the text representation of an object to the text stream by calling ToString on that object.
Public methodWrite(Single)Writes the text representation of a 4-byte floating-point value to the text stream.
Public methodWrite(String)Writes a string to the text stream.
Public methodWrite(UInt32)Writes the text representation of a 4-byte unsigned integer to the text stream.
Public methodWrite(UInt64)Writes the text representation of an 8-byte unsigned integer to the text stream.
Public methodWrite(String, Object)Writes out a formatted string, using the same semantics as String.Format.
Public methodWrite(String, Object[])Writes out a formatted string, using the same semantics as String.Format.
Public methodWrite(Char[], Int32, Int32)Writes a subarray of characters to the text stream.
Public methodWrite(String, Object, Object)Writes out a formatted string, using the same semantics as String.Format.
Public methodWriteAsync(Char)Writes a character to the text string or stream asynchronously.
Public methodWriteAsync(Char[])Writes a character array to the text string or stream asynchronously.
Public methodWriteAsync(String)Writes a string to the text string or stream asynchronously.
Public methodWriteAsync(Char[], Int32, Int32)Writes a subarray of characters to the text string or stream asynchronously.
Public methodWriteLine()Writes a line terminator to the text stream.
Public methodWriteLine(Boolean)Writes the text representation of a Boolean followed by a line terminator to the text stream.
Public methodWriteLine(Char)Writes a character followed by a line terminator to the text stream.
Public methodWriteLine(Char[])Writes an array of characters followed by a line terminator to the text stream.
Public methodWriteLine(Decimal)Writes the text representation of a decimal value followed by a line terminator to the text stream.
Public methodWriteLine(Double)Writes the text representation of a 8-byte floating-point value followed by a line terminator to the text stream.
Public methodWriteLine(Int32)Writes the text representation of a 4-byte signed integer followed by a line terminator to the text stream.
Public methodWriteLine(Int64)Writes the text representation of an 8-byte signed integer followed by a line terminator to the text stream.
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.
Public methodWriteLine(Single)Writes the text representation of a 4-byte floating-point value followed by a line terminator to the text stream.
Public methodWriteLine(String)Writes a string followed by a line terminator to the text stream.
Public methodWriteLine(UInt32)Writes the text representation of a 4-byte unsigned integer followed by a line terminator to the text stream.
Public methodWriteLine(UInt64)Writes the text representation of an 8-byte unsigned integer followed by a line terminator to the text stream.
Public methodWriteLine(String, Object)Writes out a formatted string and a new line, using the same semantics as Format.
Public methodWriteLine(String, Object[])Writes out a formatted string and a new line, using the same semantics as Format.
Public methodWriteLine(Char[], Int32, Int32)Writes a subarray of characters followed by a line terminator to the text stream.
Public methodWriteLine(String, Object, Object)Writes out a formatted string and a new line, using the same semantics as Format.
Public methodWriteLineAsync()Writes a line terminator asynchronously to the text string or stream.
Public methodWriteLineAsync(Char)Writes a character followed by a line terminator asynchronously to the text string or stream.
Public methodWriteLineAsync(Char[])Writes an array of characters followed by a line terminator asynchronously to the text string or stream.
Public methodWriteLineAsync(String)Writes a string followed by a line terminator asynchronously to the text string or stream.
Public methodWriteLineAsync(Char[], Int32, Int32)Writes a subarray of characters followed by a line terminator asynchronously to the text string or stream.
Top

  NameDescription
Protected fieldCoreNewLineStores the new line characters used for this TextWriter.
Public fieldStatic memberNullProvides a TextWriter with no backing store that can be written to, but not read from.
Top

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.

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