DocDataTextReader Class

  • Article

Derives from TextReader and provides a standard mechanism for reading from a Visual Studio text buffer.

This API is not CLS-compliant. 

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    System.IO.TextReader
      Microsoft.VisualStudio.Shell.Design.Serialization.DocDataTextReader

Namespace:  Microsoft.VisualStudio.Shell.Design.Serialization
Assembly:  Microsoft.VisualStudio.Shell.Design (in Microsoft.VisualStudio.Shell.Design.dll)

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public Class DocDataTextReader _
    Inherits TextReader _
    Implements IServiceProvider

[CLSCompliantAttribute(false)]
public class DocDataTextReader : TextReader, 
    IServiceProvider

[CLSCompliantAttribute(false)]
public ref class DocDataTextReader : public TextReader, 
    IServiceProvider

[<CLSCompliantAttribute(false)>]
type DocDataTextReader =  
    class 
        inherit TextReader 
        interface IServiceProvider 
    end

public class DocDataTextReader extends TextReader implements IServiceProvider

The DocDataTextReader type exposes the following members.

Constructors

  Name Description
Public method DocDataTextReader(DocData) Initializes a new instance of DocDataTextReader for the given doc data.
Public method DocDataTextReader(DocData, Boolean) Initializes a new instance of DocDataTextReader for the specified doc data object and determines whether Dispose will be called on the docData when the DocDataTextReader is disposed.

Top

Properties

  Name Description
Protected property DocData Gets the doc data object.

Top

Methods

  Name Description
Public method Close Closes the TextReader and releases any system resources associated with the TextReader. (Inherited from TextReader.)
Public method CreateObjRef Security Critical. 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 Dispose() Releases all resources used by the TextReader object. (Inherited from TextReader.)
Protected method Dispose(Boolean) Overrides the base class implementation to call Dispose on the underlying docData if disposeDocData was true in the overloaded constructor DocDataTextReader. (Overrides TextReader.Dispose(Boolean).)
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method 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 GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetLifetimeService Security Critical. Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method InitializeLifetimeService Security Critical. Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method 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 Peek Gets the current position in the text. (Overrides TextReader.Peek().)
Public method Read() Gets the text at the next position. (Overrides TextReader.Read().)
Public method Read(array<Char[], Int32, Int32) Sets the text of the specified buffer at the specified position. (Overrides TextReader.Read(array<Char[], Int32, Int32).)
Public method 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. (Inherited from TextReader.)
Public method ReadLine Reads a line of characters from the text reader and returns the data as a string. (Inherited from TextReader.)
Public method ReadToEnd Reads all characters from the current position to the end of the text reader and returns them as one string. (Inherited from TextReader.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IServiceProvider.GetService Gets the service of the specified type.

Top

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

Microsoft.VisualStudio.Shell.Design.Serialization Namespace