Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Enables persistence functionality for document data managed by the text buffer.
Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)
Syntax
'Declaration
<InterfaceTypeAttribute()> _
<GuidAttribute("D5D49C61-1C0B-4EA1-9ADB-A79FB1DBC7B5")> _
Public Interface IVsPersistDocData
[InterfaceTypeAttribute()]
[GuidAttribute("D5D49C61-1C0B-4EA1-9ADB-A79FB1DBC7B5")]
public interface IVsPersistDocData
[InterfaceTypeAttribute()]
[GuidAttribute(L"D5D49C61-1C0B-4EA1-9ADB-A79FB1DBC7B5")]
public interface class IVsPersistDocData
[<InterfaceTypeAttribute()>]
[<GuidAttribute("D5D49C61-1C0B-4EA1-9ADB-A79FB1DBC7B5")>]
type IVsPersistDocData = interface end
public interface IVsPersistDocData
The IVsPersistDocData type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
Close | Closes the IVsPersistDocData object. |
|
GetGuidEditorType | Returns the unique identifier of the editor factory that created the IVsPersistDocData object. |
|
IsDocDataDirty | Determines whether the document data has changed since the last save. |
|
IsDocDataReloadable | Determines whether the document data can be reloaded. |
|
LoadDocData | Loads the document data from a given MkDocument. |
|
OnRegisterDocData | Called by the Running Document Table (RDT) when it registers the document data in the RDT. |
|
ReloadDocData | Reloads the document data and in the process determines whether to ignore a subsequent file change. |
|
RenameDocData | Renames the document data. |
|
SaveDocData | Saves the document data. |
|
SetUntitledDocPath | Sets the initial name (or path) for unsaved, newly created document data. |
Top
Remarks
The environment's implementation of the DTE automation Document Object calls the following methods of IVsPersistDocData2:
IsDocDataReadOnly in get_ReadOnly property.
IsDocDataDirty in get_Saved property.
SetDocDataDirty in put_Saved property.
SetDocDataReadOnly in put_ReadOnly property.
GetGuidEditorType in get_Kind.
If your document persists to disk, the environment will also call ReloadDocData. See illustrations of the implementation and/or calling of this interface in the samples Basic Edit and Basic Project.
Implementation
Implement IVsPersistDocData in collaboration with the text buffer when needing to persist document data.