TextReader Class

Article
01/16/2013

[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.

Inheritance Hierarchy

System. . :: . .Object
  System. . :: . .MarshalByRefObject
    System.IO..::..TextReader
      System.IO. . :: . .StreamReader

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

Syntax

'Declaration
<SerializableAttribute> _
Public MustInherit Class TextReader _
    Inherits MarshalByRefObject _
    Implements IDisposable

[SerializableAttribute]
public abstract class TextReader : MarshalByRefObject, 
    IDisposable

[SerializableAttribute]
public ref class TextReader abstract : public MarshalByRefObject, 
    IDisposable

[<AbstractClass>]
[<SerializableAttribute>]
type TextReader =  
    class
        inherit MarshalByRefObject
        interface IDisposable
    end

public abstract class TextReader extends MarshalByRefObject implements 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 it 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 reader.
	Read() () () ()	Reads the next character from the text reader and advances the character position by one character.
	Read(array<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.
	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.
	ReadLine	Reads a line of characters from the text reader and returns the data as a string.
	ReadToEnd	Reads all characters from the current position to the end of the text reader and returns them as one string.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

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.

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.

Share via