TextReader Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Represents a reader that can read a sequential series of characters.

Inheritance Hierarchy

System..::.Object
System.IO..::.TextReader
System.IO..::.StreamReader
System.IO..::.StringReader

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

Syntax

Public MustInherit Class TextReader _
    Implements IDisposable
public abstract class TextReader : IDisposable

The TextReader type exposes the following members.

Constructors

Name Description
TextReader Initializes a new instance of the TextReader class.

Top

Methods

Name Description
Close Closes the TextReader and releases any system resources associated with the TextReader.
Dispose()()() Releases all resources used by the TextReader object.
Dispose(Boolean) Releases the unmanaged resources used by the TextReader and optionally releases the managed resources.
Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
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.)
GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
GetType Gets the Type of the current instance. (Inherited from Object.)
MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Peek Reads the next character without changing the state of the reader or the character source. Returns the next available character without actually reading it from the input stream.
Read()()() Reads the next character from the input stream and advances the character position by one character.
Read(array<Char>[]()[], Int32, Int32) Reads a maximum of count characters from the current stream and writes the data to buffer, beginning at index.
ReadAsync Reads a specified maximum number of characters from the current text reader asynchronously and writes the data to a buffer, beginning at the specified index.
ReadBlock Reads a maximum of count characters from the current stream, and writes the data to buffer, beginning at index.
ReadBlockAsync Reads a specified maximum number of characters from the current text reader asynchronously and writes the data to a buffer, beginning at the specified index.
ReadLine Reads a line of characters from the current stream and returns the data as a string.
ReadLineAsync Reads a line of characters asynchronously and returns the data as a string.
ReadToEnd Reads all characters from the current position to the end of the TextReader and returns them as one string.
ReadToEndAsync Reads all characters from the current position to the end of the text reader asynchronously and returns them as one string.
ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

Name Description
Null Provides a TextReader with no data to read from.

Top

Remarks

TextReader is the abstract base class of StreamReader and StringReader, which read characters from streams and strings, respectively. Use these derived classes to open a text file for reading a specified range of characters, or to create a reader based on an existing stream.

Notes to Inheritors

A derived class must minimally implement the Peek and Read methods to make a useful instance of TextReader.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

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