Share via

TextWriter Class

  • Article

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

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

Inheritance Hierarchy

System. . :: . .Object
  System. . :: . .MarshalByRefObject
    System.IO..::..TextWriter
      System.IO. . :: . .StreamWriter

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

Syntax

'Declaration
<SerializableAttribute> _
Public MustInherit Class TextWriter _
    Inherits MarshalByRefObject _
    Implements IDisposable

[SerializableAttribute]
public abstract class TextWriter : MarshalByRefObject, 
    IDisposable

[SerializableAttribute]
public ref class TextWriter abstract : public MarshalByRefObject, 
    IDisposable

[<AbstractClass>]
[<SerializableAttribute>]
type TextWriter =  
    class
        inherit MarshalByRefObject
        interface IDisposable
    end

public abstract class TextWriter extends MarshalByRefObject implements IDisposable

The TextWriter type exposes the following members.

Constructors

  Name Description
Protected method TextWriter Initializes a new instance of the TextWriter class.

Top

Properties

  Name Description
Public property Encoding When overridden in a derived class, returns the character encoding in which the output is written.
Public property NewLine Gets or sets the line terminator string used by the current TextWriter.

Top

Methods

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

Top

Fields

  Name Description
Protected field CoreNewLine Stores the newline characters used for this TextWriter.

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 TextWriter..::..Write(Char) method to make a useful instance of TextWriter.

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

System.IO Namespace