1 out of 4 rated this helpful - Rate this topic

TextWriter Class

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

Namespace:  System.IO
Assembly:  mscorlib (in mscorlib.dll)
[SerializableAttribute]
[ComVisibleAttribute(true)]
public abstract class TextWriter : MarshalByRefObject, 
	IDisposable

The TextWriter type exposes the following members.

  Name Description
Protected method Supported by the XNA Framework Supported by Portable Class Library TextWriter() Initializes a new instance of the TextWriter class.
Protected method Supported by the XNA Framework Supported by Portable Class Library TextWriter(IFormatProvider) Initializes a new instance of the TextWriter class with the specified format provider.
Top
  Name Description
Public property Supported by the XNA Framework Supported by Portable Class Library Encoding When overridden in a derived class, returns the Encoding in which the output is written.
Public property Supported by the XNA Framework Supported by Portable Class Library FormatProvider Gets an object that controls formatting.
Public property Supported by the XNA Framework Supported by Portable Class Library NewLine Gets or sets the line terminator string used by the current TextWriter.
Top
  Name Description
Public method Supported by the XNA Framework Close Closes the current writer and releases any system resources associated with the writer.
Public method 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.)
Public method Supported by the XNA Framework Supported by Portable Class Library Dispose() Releases all resources used by the TextWriter object.
Protected method Supported by the XNA Framework Supported by Portable Class Library Dispose(Boolean) Releases the unmanaged resources used by the TextWriter and optionally releases the managed resources.
Public method Supported by the XNA Framework Supported by Portable Class Library Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Supported by the XNA Framework Supported by Portable Class Library Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Supported by the XNA Framework Supported by Portable Class Library Flush Clears all buffers for the current writer and causes any buffered data to be written to the underlying device.
Public method Supported by the XNA Framework Supported by Portable Class Library GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public method Supported by the XNA Framework Supported by Portable Class Library GetType Gets the Type of the current instance. (Inherited from Object.)
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method Supported by the XNA Framework Supported by Portable Class Library MemberwiseClone() Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method MemberwiseClone(Boolean) Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Public method Static member Supported by the XNA Framework Synchronized Creates a thread-safe wrapper around the specified TextWriter.
Public method Supported by the XNA Framework Supported by Portable Class Library ToString Returns a string that represents the current object. (Inherited from Object.)
Public method Supported by the XNA Framework Supported by Portable Class Library Write(Boolean) Writes the text representation of a Boolean value to the text stream.
Public method Supported by the XNA Framework Supported by Portable Class Library Write(Char) Writes a character to the text stream.
Public method Supported by the XNA Framework Supported by Portable Class Library Write(Char[]) Writes a character array to the text stream.
Public method Supported by the XNA Framework Supported by Portable Class Library Write(Decimal) Writes the text representation of a decimal value to the text stream.
Public method Supported by the XNA Framework Supported by Portable Class Library Write(Double) Writes the text representation of an 8-byte floating-point value to the text stream.
Public method Supported by the XNA Framework Supported by Portable Class Library Write(Int32) Writes the text representation of a 4-byte signed integer to the text stream.
Public method Supported by the XNA Framework Supported by Portable Class Library Write(Int64) Writes the text representation of an 8-byte signed integer to the text stream.
Public method Supported by the XNA Framework Supported by Portable Class Library Write(Object) Writes the text representation of an object to the text stream by calling ToString on that object.
Public method Supported by the XNA Framework Supported by Portable Class Library Write(Single) Writes the text representation of a 4-byte floating-point value to the text stream.
Public method Supported by the XNA Framework Supported by Portable Class Library Write(String) Writes a string to the text stream.
Public method Supported by the XNA Framework Supported by Portable Class Library Write(UInt32) Writes the text representation of a 4-byte unsigned integer to the text stream.
Public method Supported by the XNA Framework Supported by Portable Class Library Write(UInt64) Writes the text representation of an 8-byte unsigned integer to the text stream.
Public method Supported by the XNA Framework Write(String, Object) Writes out a formatted string, using the same semantics as String.Format.
Public method Supported by the XNA Framework Supported by Portable Class Library Write(String, Object[]) Writes out a formatted string, using the same semantics as String.Format.
Public method Supported by the XNA Framework Supported by Portable Class Library Write(Char[], Int32, Int32) Writes a subarray of characters to the text stream.
Public method Supported by the XNA Framework Write(String, Object, Object) Writes out a formatted string, using the same semantics as String.Format.
Public method Write(String, Object, Object, Object) Writes out a formatted string, using the same semantics as String.Format.
Public method Supported by the XNA Framework Supported by Portable Class Library WriteLine() Writes a line terminator to the text stream.
Public method Supported by the XNA Framework Supported by Portable Class Library WriteLine(Boolean) Writes the text representation of a Boolean followed by a line terminator to the text stream.
Public method Supported by the XNA Framework Supported by Portable Class Library WriteLine(Char) Writes a character followed by a line terminator to the text stream.
Public method Supported by the XNA Framework Supported by Portable Class Library WriteLine(Char[]) Writes an array of characters followed by a line terminator to the text stream.
Public method Supported by the XNA Framework Supported by Portable Class Library WriteLine(Decimal) Writes the text representation of a decimal value followed by a line terminator to the text stream.
Public method Supported by the XNA Framework Supported by Portable Class Library WriteLine(Double) Writes the text representation of a 8-byte floating-point value followed by a line terminator to the text stream.
Public method Supported by the XNA Framework Supported by Portable Class Library WriteLine(Int32) Writes the text representation of a 4-byte signed integer followed by a line terminator to the text stream.
Public method Supported by the XNA Framework Supported by Portable Class Library WriteLine(Int64) Writes the text representation of an 8-byte signed integer followed by a line terminator to the text stream.
Public method Supported by the XNA Framework Supported by Portable Class Library WriteLine(Object) Writes the text representation of an object by calling ToString on this object, followed by a line terminator to the text stream.
Public method Supported by the XNA Framework Supported by Portable Class Library WriteLine(Single) Writes the text representation of a 4-byte floating-point value followed by a line terminator to the text stream.
Public method Supported by the XNA Framework Supported by Portable Class Library WriteLine(String) Writes a string followed by a line terminator to the text stream.
Public method Supported by the XNA Framework Supported by Portable Class Library WriteLine(UInt32) Writes the text representation of a 4-byte unsigned integer followed by a line terminator to the text stream.
Public method Supported by the XNA Framework Supported by Portable Class Library WriteLine(UInt64) Writes the text representation of an 8-byte unsigned integer followed by a line terminator to the text stream.
Public method Supported by the XNA Framework WriteLine(String, Object) Writes out a formatted string and a new line, using the same semantics as Format.
Public method Supported by the XNA Framework Supported by Portable Class Library WriteLine(String, Object[]) Writes out a formatted string and a new line, using the same semantics as Format.
Public method Supported by the XNA Framework Supported by Portable Class Library WriteLine(Char[], Int32, Int32) Writes a subarray of characters followed by a line terminator to the text stream.
Public method Supported by the XNA Framework WriteLine(String, Object, Object) Writes out a formatted string and a new line, using the same semantics as Format.
Public method WriteLine(String, Object, Object, Object) Writes out a formatted string and a new line, using the same semantics as Format.
Top
  Name Description
Protected field Supported by the XNA Framework Supported by Portable Class Library CoreNewLine Stores the new line characters used for this TextWriter.
Public field Static member Supported by the XNA Framework Supported by Portable Class Library Null Provides 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.

By default, a TextWriter is not thread safe. See TextWriter.Synchronized for a thread-safe wrapper.

For a list of common I/O tasks, see Common I/O Tasks.

Notes to Inheritors

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

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

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.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ