Skip to main content
TextWriter Class
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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
[SerializableAttribute]
[ComVisibleAttribute(true)]
public ref class TextWriter abstract : MarshalByRefObject, IDisposable
[<AbstractClass>]
[<SerializableAttribute>]
[<ComVisibleAttribute(true)>]
type TextWriter = 
    class
        inherit MarshalByRefObject
        interface IDisposable
    end
<SerializableAttribute>
<ComVisibleAttribute(True)>
Public MustInherit Class TextWriter
	Inherits MarshalByRefObject
	Implements IDisposable
NameDescription
System_CAPS_protmethod TextWriter

Initializes a new instance of the TextWriter class.

System_CAPS_protmethod TextWriter

Initializes a new instance of the TextWriter class with the specified format provider.

NameDescription
System_CAPS_pubproperty

When overridden in a derived class, returns the character encoding in which the output is written.

System_CAPS_pubproperty

Gets an object that controls formatting.

System_CAPS_pubproperty

Gets or sets the line terminator string used by the current TextWriter.

NameDescription
System_CAPS_pubmethod Close

Closes the current writer and releases any system resources associated with the writer.

System_CAPS_pubmethod 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.)

System_CAPS_pubmethod Dispose

Releases all resources used by the TextWriter object.

System_CAPS_protmethod Dispose

Releases the unmanaged resources used by the TextWriter and optionally releases the managed resources.

System_CAPS_pubmethod Equals

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethod Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethod Flush

Clears all buffers for the current writer and causes any buffered data to be written to the underlying device.

System_CAPS_pubmethod FlushAsync

Asynchronously clears all buffers for the current writer and causes any buffered data to be written to the underlying device.

System_CAPS_pubmethod GetHashCode

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethod GetLifetimeService

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethod GetType

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethod InitializeLifetimeService

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_protmethod MemberwiseClone

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone

Creates a shallow copy of the current MarshalByRefObject object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethod System_CAPS_static Synchronized

Creates a thread-safe wrapper around the specified TextWriter.

System_CAPS_pubmethod ToString

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethod Write

Writes the text representation of a Boolean value to the text string or stream.

System_CAPS_pubmethod Write

Writes a character to the text string or stream.

System_CAPS_pubmethod Write

Writes a character array to the text string or stream.

System_CAPS_pubmethod Write

Writes a subarray of characters to the text string or stream.

System_CAPS_pubmethod Write

Writes the text representation of a decimal value to the text string or stream.

System_CAPS_pubmethod Write

Writes the text representation of an 8-byte floating-point value to the text string or stream.

System_CAPS_pubmethod Write

Writes the text representation of a 4-byte signed integer to the text string or stream.

System_CAPS_pubmethod Write

Writes the text representation of an 8-byte signed integer to the text string or stream.

System_CAPS_pubmethod Write

Writes the text representation of an object to the text string or stream by calling the ToString method on that object.

System_CAPS_pubmethod Write

Writes the text representation of a 4-byte floating-point value to the text string or stream.

System_CAPS_pubmethod Write

Writes a string to the text string or stream.

System_CAPS_pubmethod Write

Writes a formatted string to the text string or stream, using the same semantics as the StringFormat method.

System_CAPS_pubmethod Write

Writes a formatted string to the text string or stream, using the same semantics as the StringFormat method.

System_CAPS_pubmethod Write

Writes a formatted string to the text string or stream, using the same semantics as the StringFormat method.

System_CAPS_pubmethod Write

Writes a formatted string to the text string or stream, using the same semantics as the StringFormat method.

System_CAPS_pubmethod Write

Writes the text representation of a 4-byte unsigned integer to the text string or stream.

System_CAPS_pubmethod Write

Writes the text representation of an 8-byte unsigned integer to the text string or stream.

System_CAPS_pubmethod WriteAsync

Writes a character to the text string or stream asynchronously.

System_CAPS_pubmethod WriteAsync

Writes a character array to the text string or stream asynchronously.

System_CAPS_pubmethod WriteAsync

Writes a subarray of characters to the text string or stream asynchronously.

System_CAPS_pubmethod WriteAsync

Writes a string to the text string or stream asynchronously.

System_CAPS_pubmethod WriteLine

Writes a line terminator to the text string or stream.

System_CAPS_pubmethod WriteLine

Writes the text representation of a Boolean value followed by a line terminator to the text string or stream.

System_CAPS_pubmethod WriteLine

Writes a character followed by a line terminator to the text string or stream.

System_CAPS_pubmethod WriteLine

Writes an array of characters followed by a line terminator to the text string or stream.

System_CAPS_pubmethod WriteLine

Writes a subarray of characters followed by a line terminator to the text string or stream.

System_CAPS_pubmethod WriteLine

Writes the text representation of a decimal value followed by a line terminator to the text string or stream.

System_CAPS_pubmethod WriteLine

Writes the text representation of a 8-byte floating-point value followed by a line terminator to the text string or stream.

System_CAPS_pubmethod WriteLine

Writes the text representation of a 4-byte signed integer followed by a line terminator to the text string or stream.

System_CAPS_pubmethod WriteLine

Writes the text representation of an 8-byte signed integer followed by a line terminator to the text string or stream.

System_CAPS_pubmethod WriteLine

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.

System_CAPS_pubmethod WriteLine

Writes the text representation of a 4-byte floating-point value followed by a line terminator to the text string or stream.

System_CAPS_pubmethod WriteLine

Writes a string followed by a line terminator to the text string or stream.

System_CAPS_pubmethod WriteLine

Writes a formatted string and a new line to the text string or stream, using the same semantics as the StringFormat method.

System_CAPS_pubmethod WriteLine

Writes a formatted string and a new line to the text string or stream, using the same semantics as the StringFormat method.

System_CAPS_pubmethod WriteLine

Writes out a formatted string and a new line, using the same semantics as Format.

System_CAPS_pubmethod WriteLine

Writes out a formatted string and a new line, using the same semantics as Format.

System_CAPS_pubmethod WriteLine

Writes the text representation of a 4-byte unsigned integer followed by a line terminator to the text string or stream.

System_CAPS_pubmethod WriteLine

Writes the text representation of an 8-byte unsigned integer followed by a line terminator to the text string or stream.

System_CAPS_pubmethod WriteLineAsync

Writes a line terminator asynchronously to the text string or stream.

System_CAPS_pubmethod WriteLineAsync

Writes a character followed by a line terminator asynchronously to the text string or stream.

System_CAPS_pubmethod WriteLineAsync

Writes an array of characters followed by a line terminator asynchronously to the text string or stream.

System_CAPS_pubmethod WriteLineAsync

Writes a subarray of characters followed by a line terminator asynchronously to the text string or stream.

System_CAPS_pubmethod WriteLineAsync

Writes a string followed by a line terminator asynchronously to the text string or stream.

NameDescription
System_CAPS_protfield CoreNewLine

Stores the newline characters used for this TextWriter.

System_CAPS_pubfield System_CAPS_static Null

Provides a TextWriter with no backing store that can be written to, but not read from.

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 TextWriterSynchronized for a thread-safe wrapper.

System_CAPS_importantImportant

This type implements the IDisposable interface. When you have finished using any type that derives from this type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its Dispose method in a try/catch block. To dispose of it indirectly, use a language construct such as using (in C#) or Using (in Visual Basic). For more information, see Dispose and the “Using an Object that Implements IDisposable” section in the IDisposable interface topic.

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

Notes to Inheritors:

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

The TextWriter class is an abstract class. Therefore, you do not instantiate it in your code. The StreamWriter class derives from TextWriter and provides implementations of the members for writing to a stream. The following example shows how to write two lines that consist of string values to a text file by using the WriteLineAsync method.

Override Dispose in a derived class to provide

using System;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            WriteCharacters();
        }

        static async void WriteCharacters()
        {
            using (StreamWriter writer = File.CreateText("newfile.txt"))
            {
                await writer.WriteLineAsync("First line of example");
                await writer.WriteLineAsync("and second line");
            }
        }
    }
}
Imports System.IO
Imports System.Text

Module Module1

    Sub Main()
        WriteCharacters()
    End Sub

    Async Sub WriteCharacters()
        Using writer As StreamWriter = File.CreateText("newfile.txt")
            Await writer.WriteLineAsync("First line of example")
            Await writer.WriteLineAsync("and second line")
        End Using
    End Sub
End Module
Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top