DocData Class
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
‘선언
<CLSCompliantAttribute(False)> _
Public Class DocData _
Implements IDisposable, IVsTextStreamEvents, IVsDocumentLockHolder
[CLSCompliantAttribute(false)]
public class DocData : IDisposable, IVsTextStreamEvents,
IVsDocumentLockHolder
The DocData type exposes the following members.
Constructors
Name | Description | |
---|---|---|
DocData(Object) | Initializes a new DocData object for the given buffer. | |
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 | |
---|---|---|
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. |
Top
Methods
Name | Description | |
---|---|---|
CheckoutFile | 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. | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | Called automatically when this object is destroyed. (Overrides Object.Finalize().) | |
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.) | |
Modify | Marks this DocData as modified. | |
OnDataChanged | Called when an external change has been made to the doc data. | |
OnModifying | Called by Modify. | |
RaiseModifying | Raises the Modifying event. | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Events
Name | Description | |
---|---|---|
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. |
Top
Explicit Interface Implementations
Name | Description | |
---|---|---|
IVsTextStreamEvents.OnChangeStreamAttributes | A notification from Visual Studio that something in the text has changed. | |
IVsTextStreamEvents.OnChangeStreamText | Provides a notification from Visual Studio that something in the text has changed. | |
IVsDocumentLockHolder.CloseDocumentHolder | Close the document based on a user request. | |
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.