Partager via


TextWriter Class

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

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

Inheritance Hierarchy

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

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

Syntax

'Declaration
<ComVisibleAttribute(True)> _
Public MustInherit Class TextWriter _
    Implements IDisposable
[ComVisibleAttribute(true)]
public abstract class TextWriter : IDisposable

The TextWriter type exposes the following members.

Constructors

  Name Description
Protected methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 TextWriter() Initializes a new instance of the TextWriter class.
Protected methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 TextWriter(IFormatProvider) Initializes a new instance of the TextWriter class with the specified format provider.

Top

Properties

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

Top

Methods

  Name Description
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Close Closes the current writer and releases any system resources associated with the writer.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Dispose() Releases all resources used by the TextWriter object.
Protected methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Dispose(Boolean) Releases the unmanaged resources used by the TextWriter and optionally releases the managed resources.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 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.)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Flush Clears all buffers for the current writer and causes any buffered data to be written to the underlying device.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 GetType Gets the Type of the current instance. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 ToString Returns a string that represents the current object. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(Boolean) Writes the text representation of a Boolean value to the text stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(Char) Writes a character to the text stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(array<Char[]) Writes a character array to the text stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(Decimal) Writes the text representation of a decimal value to the text stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(Double) Writes the text representation of an 8-byte floating-point value to the text stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(Int32) Writes the text representation of a 4-byte signed integer to the text stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(Int64) Writes the text representation of an 8-byte signed integer to the text stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(Object) Writes the text representation of an object to the text stream by calling ToString on that object.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(Single) Writes the text representation of a 4-byte floating-point value to the text stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(String) Writes a string to the text stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(UInt32) Writes the text representation of a 4-byte unsigned integer to the text stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(UInt64) Writes the text representation of an 8-byte unsigned integer to the text stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(String, Object) Writes out a formatted string, using the same semantics as String.Format.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(String, array<Object[]) Writes out a formatted string, using the same semantics as String.Format.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(array<Char[], Int32, Int32) Writes a subarray of characters to the text stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(String, Object, Object) Writes out a formatted string, using the same semantics as String.Format.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 WriteLine() Writes a line terminator to the text stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 WriteLine(Boolean) Writes the text representation of a Boolean followed by a line terminator to the text stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 WriteLine(Char) Writes a character followed by a line terminator to the text stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 WriteLine(array<Char[]) Writes an array of characters followed by a line terminator to the text stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 WriteLine(Decimal) Writes the text representation of a decimal value followed by a line terminator to the text stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 WriteLine(Double) Writes the text representation of a 8-byte floating-point value followed by a line terminator to the text stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 WriteLine(Int32) Writes the text representation of a 4-byte signed integer followed by a line terminator to the text stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 WriteLine(Int64) Writes the text representation of an 8-byte signed integer followed by a line terminator to the text stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 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 methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 WriteLine(Single) Writes the text representation of a 4-byte floating-point value followed by a line terminator to the text stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 WriteLine(String) Writes a string followed by a line terminator to the text stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 WriteLine(UInt32) Writes the text representation of a 4-byte unsigned integer followed by a line terminator to the text stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 WriteLine(UInt64) Writes the text representation of an 8-byte unsigned integer followed by a line terminator to the text stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 WriteLine(String, Object) Writes out a formatted string and a new line, using the same semantics as Format.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 WriteLine(String, array<Object[]) Writes out a formatted string and a new line, using the same semantics as Format.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 WriteLine(array<Char[], Int32, Int32) Writes a subarray of characters followed by a line terminator to the text stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 WriteLine(String, Object, Object) Writes out a formatted string and a new line, using the same semantics as Format.

Top

Fields

  Name Description
Protected fieldSupported by Silverlight for Windows PhoneSupported by Xbox 360 CoreNewLine Stores the new line characters used for this TextWriter.
Public fieldStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360 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