Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

TextReader Class

.NET Framework 4.5

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

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

System.Object
  System.MarshalByRefObject
    System.IO.TextReader
      System.IO.StreamReader
      System.IO.StringReader

Namespace:  System.IO
Assembly:  mscorlib (in mscorlib.dll)
C#
C++
F#
VB
Copy 

[SerializableAttribute]
[ComVisibleAttribute(true)]
public abstract class TextReader : MarshalByRefObject, 
	IDisposable

The TextReader type exposes the following members.

  Name Description
Protected method Supported by the XNA Framework Supported by Portable Class Library TextReader Initializes a new instance of the TextReader class.
Top
  Name Description
Public method Supported by the XNA Framework Close Closes the TextReader and releases any system resources associated with the TextReader.
Public method 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.)
Public method Supported by the XNA Framework Supported by Portable Class Library Dispose() Releases all resources used by the TextReader object.
Protected method Supported by the XNA Framework Supported by Portable Class Library Dispose(Boolean) Releases the unmanaged resources used by the TextReader and optionally releases the managed resources.
Public method Supported by the XNA Framework Supported by Portable Class Library Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Supported by the XNA Framework Supported by Portable Class Library Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Supported by the XNA Framework Supported by Portable Class Library GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public method Supported by the XNA Framework Supported by Portable Class Library GetType Gets the Type of the current instance. (Inherited from Object.)
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method Supported by the XNA Framework Supported by Portable Class Library MemberwiseClone() Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method MemberwiseClone(Boolean) Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Public method Supported by the XNA Framework Supported by Portable Class Library 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 reader.
Public method Supported by the XNA Framework Supported by Portable Class Library Read() Reads the next character from the text reader and advances the character position by one character.
Public method Supported by the XNA Framework Supported by Portable Class Library Read(Char[], Int32, Int32) Reads a specified maximum number of characters from the current reader and writes the data to a buffer, beginning at the specified index.
Public method 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.
Public method Supported by the XNA Framework Supported by Portable Class Library ReadBlock Reads a specified maximum number of characters from the current text reader and writes the data to a buffer, beginning at the specified index.
Public method 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.
Public method Supported by the XNA Framework Supported by Portable Class Library ReadLine Reads a line of characters from the text reader and returns the data as a string.
Public method ReadLineAsync Reads a line of characters asynchronously and returns the data as a string.
Public method Supported by the XNA Framework Supported by Portable Class Library ReadToEnd Reads all characters from the current position to the end of the text reader and returns them as one string.
Public method ReadToEndAsync Reads all characters from the current position to the end of the text reader asynchronously and returns them as one string.
Public method Static member Supported by the XNA Framework Synchronized Creates a thread-safe wrapper around the specified TextReader.
Public method Supported by the XNA Framework Supported by Portable Class Library ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Public field Static member Supported by the XNA Framework Supported by Portable Class Library Null Provides a TextReader with no data to read from.
Top

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.

.NET Framework

Supported in: 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

Windows 8 Release Preview, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 SP2, 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.
Did you find this helpful?
(1500 characters remaining)