TextReader Class

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

'Declaration
<ComVisibleAttribute(True)> _
Public MustInherit Class TextReader _
    Implements IDisposable
[ComVisibleAttribute(true)]
public abstract class TextReader : IDisposable

The TextReader type exposes the following members.

Constructors

  Name Description
Protected methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 TextReader Initializes a new instance of the TextReader class.

Top

Methods

  Name Description
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Close Closes the TextReader and releases any system resources associated with the TextReader.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Dispose() Releases all resources used by the TextReader object.
Protected methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Dispose(Boolean) Releases the unmanaged resources used by the TextReader and optionally releases the managed resources.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 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.)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 GetType Gets the Type of the current instance. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 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.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Read() Reads the next character from the input stream and advances the character position by one character.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Read(array<Char[], Int32, Int32) Reads a maximum of count characters from the current stream and writes the data to buffer, beginning at index.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 ReadBlock Reads a maximum of count characters from the current stream, and writes the data to buffer, beginning at index.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 ReadLine Reads a line of characters from the current stream and returns the data as a string.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 ReadToEnd Reads all characters from the current position to the end of the TextReader and returns them as one string.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

  Name Description
Public fieldStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360 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

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

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