DocData Class

Definition

Important

This API is not CLS-compliant.

A wrapper around a DocData object that provides additional features.

public ref class DocData : IDisposable, Microsoft::VisualStudio::Shell::Interop::IVsDocumentLockHolder, Microsoft::VisualStudio::TextManager::Interop::IVsTextStreamEvents
[System.CLSCompliant(false)]
public class DocData : IDisposable, Microsoft.VisualStudio.Shell.Interop.IVsDocumentLockHolder, Microsoft.VisualStudio.TextManager.Interop.IVsTextStreamEvents
type DocData = class
    interface IDisposable
    interface IVsTextStreamEvents
    interface IVsDocumentLockHolder
Public Class DocData
Implements IDisposable, IVsDocumentLockHolder, IVsTextStreamEvents
Inheritance
DocData
Attributes
Implements

Constructors

DocData(IServiceProvider, String)

Initializes a new instance of DocData from the specified file and sets the site from the specified site.

DocData(Object)

Initializes a new DocData object for the given buffer.

Properties

Buffer

The text buffer contained within the doc data.

Data

The actual DocData object this class wraps.

Modified

Determines whether the buffer has been modified

Name

Gets the file name of the doc data.

Methods

CheckoutFile(IServiceProvider)

Checks out the doc data file from source code control.

CreateChangeMarker()

Marks the beginning of an external change of the text buffer.

Dispose()

Disposes the DocData.

Dispose(Boolean)

Disposes the DocData.

Finalize()

Called automatically when this object is destroyed.

Modify()

Marks this DocData as modified.

OnDataChanged(EventArgs)

Called when an external change has been made to the doc data.

OnModifying(EventArgs)

Called by Modify().

RaiseModifying()

Raises the Modifying event.

Events

DataChanged

An event that is raised when the data contained within this doc data has changed.

Modifying

An event that is raised when this DocData object is being marked as modified.

Explicit Interface Implementations

IVsDocumentLockHolder.CloseDocumentHolder(UInt32)

Close the document based on a user request.

IVsDocumentLockHolder.ShowDocumentHolder()

Called by Visual Studio to show the window frame associated with this document.

IVsTextStreamEvents.OnChangeStreamAttributes(Int32, Int32)

A notification from Visual Studio that something in the text has changed.

IVsTextStreamEvents.OnChangeStreamText(Int32, Int32, Int32, Int32)

Provides a notification from Visual Studio that something in the text has changed.

Applies to