Export (0) Print
Expand All

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.

  NameDescription
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsTextWriter()Initializes a new instance of the TextWriter class.
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsTextWriter(IFormatProvider)Initializes a new instance of the TextWriter class with the specified format provider.
Top

  NameDescription
Public propertySupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsEncodingWhen overridden in a derived class, returns the character encoding in which the output is written.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsFormatProviderGets an object that controls formatting.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsNewLineGets or sets the line terminator string used by the current TextWriter.
Top

  NameDescription
Public methodSupported by the XNA FrameworkCloseCloses the current writer and releases any system resources associated with the writer.
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsDispose()Releases all resources used by the TextWriter object.
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsDispose(Boolean)Releases the unmanaged resources used by the TextWriter and optionally releases the managed resources.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsFlushClears all buffers for the current writer and causes any buffered data to be written to the underlying device.
Public methodSupported in .NET for Windows Store appsFlushAsyncAsynchronously clears all buffers for the current writer and causes any buffered data to be written to the underlying device.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsMemberwiseClone()Creates a shallow copy of the current Object. (Inherited from Object.)
Protected methodMemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Public methodStatic memberSupported by the XNA FrameworkSynchronizedCreates a thread-safe wrapper around the specified TextWriter.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(Boolean)Writes the text representation of a Boolean value to the text string or stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(Char)Writes a character to the text string or stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(Char[])Writes a character array to the text string or stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(Decimal)Writes the text representation of a decimal value to the text string or stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(Double)Writes the text representation of an 8-byte floating-point value to the text string or stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(Int32)Writes the text representation of a 4-byte signed integer to the text string or stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(Int64)Writes the text representation of an 8-byte signed integer to the text string or stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(Object)Writes the text representation of an object to the text string or stream by calling the ToString method on that object.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(Single)Writes the text representation of a 4-byte floating-point value to the text string or stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(String)Writes a string to the text string or stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(UInt32)Writes the text representation of a 4-byte unsigned integer to the text string or stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(UInt64)Writes the text representation of an 8-byte unsigned integer to the text string or stream.
Public methodSupported by the XNA FrameworkWrite(String, Object)Writes a formatted string to the text string or stream, using the same semantics as the String.Format(String, Object) method.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(String, Object[])Writes a formatted string to the text string or stream, using the same semantics as the String.Format(String, Object[]) method.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(Char[], Int32, Int32)Writes a subarray of characters to the text string or stream.
Public methodSupported by the XNA FrameworkWrite(String, Object, Object)Writes a formatted string to the text string or stream, using the same semantics as the String.Format(String, Object, Object) method.
Public methodWrite(String, Object, Object, Object)Writes a formatted string to the text string or stream, using the same semantics as the String.Format(String, Object, Object, Object) method.
Public methodSupported in .NET for Windows Store appsWriteAsync(Char)Writes a character to the text string or stream asynchronously.
Public methodSupported in .NET for Windows Store appsWriteAsync(Char[])Writes a character array to the text string or stream asynchronously.
Public methodSupported in .NET for Windows Store appsWriteAsync(String)Writes a string to the text string or stream asynchronously.
Public methodSupported in .NET for Windows Store appsWriteAsync(Char[], Int32, Int32)Writes a subarray of characters to the text string or stream asynchronously.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine()Writes a line terminator to the text string or stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(Boolean)Writes the text representation of a Boolean value followed by a line terminator to the text string or stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(Char)Writes a character followed by a line terminator to the text string or stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(Char[])Writes an array of characters followed by a line terminator to the text string or stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(Decimal)Writes the text representation of a decimal value followed by a line terminator to the text string or stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(Double)Writes the text representation of a 8-byte floating-point value followed by a line terminator to the text string or stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(Int32)Writes the text representation of a 4-byte signed integer followed by a line terminator to the text string or stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(Int64)Writes the text representation of an 8-byte signed integer followed by a line terminator to the text string or stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(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 methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(Single)Writes the text representation of a 4-byte floating-point value followed by a line terminator to the text string or stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(String)Writes a string followed by a line terminator to the text string or stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(UInt32)Writes the text representation of a 4-byte unsigned integer followed by a line terminator to the text string or stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(UInt64)Writes the text representation of an 8-byte unsigned integer followed by a line terminator to the text string or stream.
Public methodSupported by the XNA FrameworkWriteLine(String, Object)Writes a formatted string and a new line to the text string or stream, using the same semantics as the String.Format(String, Object) method.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(String, Object[])Writes out a formatted string and a new line, using the same semantics as Format.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(Char[], Int32, Int32)Writes a subarray of characters followed by a line terminator to the text string or stream.
Public methodSupported by the XNA FrameworkWriteLine(String, Object, Object)Writes a formatted string and a new line to the text string or stream, using the same semantics as the String.Format(String, Object, Object) method.
Public methodWriteLine(String, Object, Object, Object)Writes out a formatted string and a new line, using the same semantics as Format.
Public methodSupported in .NET for Windows Store appsWriteLineAsync()Writes a line terminator asynchronously to the text string or stream.
Public methodSupported in .NET for Windows Store appsWriteLineAsync(Char)Writes a character followed by a line terminator asynchronously to the text string or stream.
Public methodSupported in .NET for Windows Store appsWriteLineAsync(Char[])Writes an array of characters followed by a line terminator asynchronously to the text string or stream.
Public methodSupported in .NET for Windows Store appsWriteLineAsync(String)Writes a string followed by a line terminator asynchronously to the text string or stream.
Public methodSupported in .NET for Windows Store appsWriteLineAsync(Char[], Int32, Int32)Writes a subarray of characters followed by a line terminator asynchronously to the text string or stream.
Top

  NameDescription
Protected fieldSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsCoreNewLineStores the newline characters used for this TextWriter.
Public fieldStatic memberSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsNullProvides 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.

Important noteImportant

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 TextWriter.Write(Char) 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(String) 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");
            }
        }
    }
}

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 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

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.
Show:
© 2014 Microsoft