Share via

DocDataTextWriter Class

Provides a standard System.IO mechanism for writing to a Visual Studio text buffer.

This API is not CLS-compliant. 

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    System.IO.TextWriter
      Microsoft.VisualStudio.Shell.Design.Serialization.DocDataTextWriter

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

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public Class DocDataTextWriter _
    Inherits TextWriter _
    Implements IServiceProvider

[CLSCompliantAttribute(false)]
public class DocDataTextWriter : TextWriter, 
    IServiceProvider

[CLSCompliantAttribute(false)]
public ref class DocDataTextWriter : public TextWriter, 
    IServiceProvider

[<CLSCompliantAttribute(false)>]
type DocDataTextWriter =  
    class
        inherit TextWriter
        interface IServiceProvider
    end

public class DocDataTextWriter extends TextWriter implements IServiceProvider

The DocDataTextWriter type exposes the following members.

Constructors

  Name Description
Public method DocDataTextWriter(DocData) Initializes a new instance of DocDataTextWriter for the given doc data.
Public method DocDataTextWriter(DocData, Boolean) Initializes a new instance of DocDataTextWriter for the specified doc data, and determines whether or not to dispose the doc data object when this instance is closed or disposed.

Top

Properties

  Name Description
Protected property DocData Gets the doc data object.
Public property Encoding Gets the encoding of this text writer. (Overrides TextWriter.Encoding.)
Public property FormatProvider Gets an object that controls formatting. (Inherited from TextWriter.)
Public property NewLine Gets or sets the line terminator string used by the current TextWriter. (Inherited from TextWriter.)

Top

Methods

  Name Description
Public method Close Closes the current writer and releases any system resources associated with the writer. (Inherited from TextWriter.)
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 Dispose() Releases all resources used by the TextWriter object. (Inherited from TextWriter.)
Protected method Dispose(Boolean) Disposes the object and its resources. (Overrides TextWriter.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 Flush Replaces the contents of the text stream with the contents of the string builder. (Overrides TextWriter.Flush().)
Public method 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 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 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 ToString Returns a string that represents the current object. (Inherited from Object.)
Public method Write(array<Char[]) Writes a character array to the text stream. (Inherited from TextWriter.)
Public method Write(Boolean) Writes the text representation of a Boolean value to the text stream. (Inherited from TextWriter.)
Public method Write(Int32) Writes the text representation of a 4-byte signed integer to the text stream. (Inherited from TextWriter.)
Public method Write(UInt32) Writes the text representation of a 4-byte unsigned integer to the text stream. (Inherited from TextWriter.)
Public method Write(Int64) Writes the text representation of an 8-byte signed integer to the text stream. (Inherited from TextWriter.)
Public method Write(UInt64) Writes the text representation of an 8-byte unsigned integer to the text stream. (Inherited from TextWriter.)
Public method Write(Single) Writes the text representation of a 4-byte floating-point value to the text stream. (Inherited from TextWriter.)
Public method Write(Double) Writes the text representation of an 8-byte floating-point value to the text stream. (Inherited from TextWriter.)
Public method Write(Decimal) Writes the text representation of a decimal value to the text stream. (Inherited from TextWriter.)
Public method Write(Object) Writes the text representation of an object to the text stream by calling ToString on that object. (Inherited from TextWriter.)
Public method Write(Char) Appends a char to the underlying StringBuilder. (Overrides TextWriter.Write(Char).)
Public method Write(String) Appends a string to the underlying StringBuilder. (Overrides TextWriter.Write(String).)
Public method Write(String, Object) Writes out a formatted string, using the same semantics as String.Format. (Inherited from TextWriter.)
Public method Write(String, array<Object[]) Writes out a formatted string, using the same semantics as String.Format. (Inherited from TextWriter.)
Public method Write(array<Char[], Int32, Int32) Writes a subarray of characters to the text stream. (Inherited from TextWriter.)
Public method Write(String, Object, Object) Writes out a formatted string, using the same semantics as String.Format. (Inherited from TextWriter.)
Public method Write(String, Object, Object, Object) Writes out a formatted string, using the same semantics as String.Format. (Inherited from TextWriter.)
Public method WriteLine() Writes a line terminator to the text stream. (Inherited from TextWriter.)
Public method WriteLine(Char) Writes a character followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public method WriteLine(array<Char[]) Writes an array of characters followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public method WriteLine(Boolean) Writes the text representation of a Boolean followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public method WriteLine(Int32) Writes the text representation of a 4-byte signed integer followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public method WriteLine(UInt32) Writes the text representation of a 4-byte unsigned integer followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public method WriteLine(Int64) Writes the text representation of an 8-byte signed integer followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public method WriteLine(UInt64) Writes the text representation of an 8-byte unsigned integer followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public method WriteLine(Single) Writes the text representation of a 4-byte floating-point value followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public method WriteLine(Double) Writes the text representation of a 8-byte floating-point value followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public method WriteLine(Decimal) Writes the text representation of a decimal value followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public method WriteLine(String) Writes a string followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public method WriteLine(Object) Writes the text representation of an object by calling ToString on this object, followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public method WriteLine(String, Object) Writes out a formatted string and a new line, using the same semantics as Format. (Inherited from TextWriter.)
Public method WriteLine(String, array<Object[]) Writes out a formatted string and a new line, using the same semantics as Format. (Inherited from TextWriter.)
Public method WriteLine(array<Char[], Int32, Int32) Writes a subarray of characters followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public method WriteLine(String, Object, Object) Writes out a formatted string and a new line, using the same semantics as Format. (Inherited from TextWriter.)
Public method WriteLine(String, Object, Object, Object) Writes out a formatted string and a new line, using the same semantics as Format. (Inherited from TextWriter.)

Top

Fields

  Name Description
Protected field CoreNewLine Stores the new line characters used for this TextWriter. (Inherited from TextWriter.)

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