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
Assemblies:   mscorlib (in mscorlib.dll)
  System.IO (in System.IO.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 LibraryTextWriter()Initializes a new instance of the TextWriter class.
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibraryTextWriter(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 LibraryEncodingWhen overridden in a derived class, returns the character encoding in which the output is written.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryFormatProviderGets an object that controls formatting.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryNewLineGets 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 LibraryDispose()Releases all resources used by the TextWriter object.
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibraryDispose(Boolean)Releases the unmanaged resources used by the TextWriter and optionally releases the managed resources.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibraryFinalizeAllows 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 LibraryFlushClears all buffers for the current writer and causes any buffered data to be written to the underlying device.
Public methodFlushAsyncAsynchronously 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 LibraryGetHashCodeServes 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 LibraryGetTypeGets 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 LibraryMemberwiseClone()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 LibraryToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Boolean)Writes the text representation of a Boolean value to the text string or stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Char)Writes a character to the text string or stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Char[])Writes a character array to the text string or stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Decimal)Writes the text representation of a decimal value to the text string or stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(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 LibraryWrite(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 LibraryWrite(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 LibraryWrite(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 LibraryWrite(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 LibraryWrite(String)Writes a string to the text string or stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(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 LibraryWrite(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 LibraryWrite(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 LibraryWrite(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 methodWriteAsync(Char)Writes a character to the text string or stream asynchronously.
Public methodWriteAsync(Char[])Writes a character array to the text string or stream asynchronously.
Public methodWriteAsync(String)Writes a string to the text string or stream asynchronously.
Public methodWriteAsync(Char[], Int32, Int32)Writes a subarray of characters to the text string or stream asynchronously.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine()Writes a line terminator to the text string or stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine(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 LibraryWriteLine(Char)Writes a character followed by a line terminator to the text string or stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine(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 LibraryWriteLine(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 LibraryWriteLine(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 LibraryWriteLine(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 LibraryWriteLine(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 LibraryWriteLine(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 LibraryWriteLine(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 LibraryWriteLine(String)Writes a string followed by a line terminator to the text string or stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine(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 LibraryWriteLine(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 LibraryWriteLine(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 LibraryWriteLine(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 methodWriteLineAsync()Writes a line terminator asynchronously to the text string or stream.
Public methodWriteLineAsync(Char)Writes a character followed by a line terminator asynchronously to the text string or stream.
Public methodWriteLineAsync(Char[])Writes an array of characters followed by a line terminator asynchronously to the text string or stream.
Public methodWriteLineAsync(String)Writes a string followed by a line terminator asynchronously to the text string or stream.
Public methodWriteLineAsync(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 LibraryCoreNewLineStores the newline characters used for this TextWriter.
Public fieldStatic memberSupported by the XNA FrameworkSupported by Portable Class LibraryNullProvides 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.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8

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:
© 2015 Microsoft