DocData Class

  • Article

A wrapper around a DocData object that provides additional features.

This API is not CLS-compliant. 

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Shell.Design.Serialization.DocData

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

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public Class DocData _
    Implements IDisposable, IVsTextStreamEvents, IVsDocumentLockHolder

[CLSCompliantAttribute(false)]
public class DocData : IDisposable, IVsTextStreamEvents, 
    IVsDocumentLockHolder

[CLSCompliantAttribute(false)]
public ref class DocData : IDisposable, 
    IVsTextStreamEvents, IVsDocumentLockHolder

[<CLSCompliantAttribute(false)>]
type DocData =  
    class
        interface IDisposable
        interface IVsTextStreamEvents
        interface IVsDocumentLockHolder
    end

public class DocData implements IDisposable, IVsTextStreamEvents, IVsDocumentLockHolder

The DocData type exposes the following members.

Constructors

  Name Description
Public method DocData(Object) Initializes a new DocData object for the given buffer.
Public method DocData(IServiceProvider, String) Initializes a new instance of DocData from the specified file and sets the site from the specified site.

Top

Properties

  Name Description
Public property Buffer The text buffer contained within the doc data.
Public property Data The actual DocData object this class wraps.
Public property Modified Determines whether the buffer has been modified
Public property Name Gets the file name of the doc data.

Top

Methods

  Name Description
Public method CheckoutFile Checks out the doc data file from source code control.
Public method CreateChangeMarker Marks the beginning of an external change of the text buffer.
Public method Dispose() Disposes the DocData.
Protected method Dispose(Boolean) Disposes the DocData.
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Called automatically when this object is destroyed. (Overrides Object.Finalize().)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Modify Marks this DocData as modified.
Protected method OnDataChanged Called when an external change has been made to the doc data.
Protected method OnModifying Called by Modify.
Public method RaiseModifying Raises the Modifying event.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Events

  Name Description
Public event DataChanged An event that is raised when the data contained within this doc data has changed.
Public event Modifying An event that is raised when this DocData object is being marked as modified.

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IVsTextStreamEvents.OnChangeStreamAttributes A notification from Visual Studio that something in the text has changed.
Explicit interface implemetationPrivate method IVsTextStreamEvents.OnChangeStreamText Provides a notification from Visual Studio that something in the text has changed.
Explicit interface implemetationPrivate method IVsDocumentLockHolder.CloseDocumentHolder Close the document based on a user request.
Explicit interface implemetationPrivate method IVsDocumentLockHolder.ShowDocumentHolder Called by Visual Studio to show the window frame associated with this document.

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