Partilhar via

IVsPersistDocData Interface

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Shell.Interop
Assembly:
Microsoft.VisualStudio.Shell.Interop.dll
Assembly:
Microsoft.VisualStudio.Interop.dll
Package:
Microsoft.VisualStudio.Interop v17.12.40391

Enables persistence functionality for document data managed by the text buffer.

public interface class IVsPersistDocData
public interface class IVsPersistDocData
__interface IVsPersistDocData
[System.Runtime.InteropServices.Guid("D5D49C61-1C0B-4EA1-9ADB-A79FB1DBC7B5")]
[System.Runtime.InteropServices.InterfaceType(1)]
public interface IVsPersistDocData
[System.Runtime.InteropServices.Guid("D5D49C61-1C0B-4EA1-9ADB-A79FB1DBC7B5")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsPersistDocData
[<System.Runtime.InteropServices.Guid("D5D49C61-1C0B-4EA1-9ADB-A79FB1DBC7B5")>]
[<System.Runtime.InteropServices.InterfaceType(1)>]
type IVsPersistDocData = interface
[<System.Runtime.InteropServices.Guid("D5D49C61-1C0B-4EA1-9ADB-A79FB1DBC7B5")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IVsPersistDocData = interface
Public Interface IVsPersistDocData
Derived
Attributes
GuidAttribute InterfaceTypeAttribute

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.

Methods

Close()

Closes the IVsPersistDocData object.
GetGuidEditorType(Guid)

Returns the unique identifier of the editor factory that created the IVsPersistDocData object.
IsDocDataDirty(Int32)

Determines whether the document data has changed since the last save.
IsDocDataReloadable(Int32)

Determines whether the document data can be reloaded.
LoadDocData(String)

Loads the document data from a given MkDocument.
OnRegisterDocData(UInt32, IVsHierarchy, UInt32)

Called by the Running Document Table (RDT) when it registers the document data in the RDT.
ReloadDocData(UInt32)

Reloads the document data and in the process determines whether to ignore a subsequent file change.
RenameDocData(UInt32, IVsHierarchy, UInt32, String)

Renames the document data.
SaveDocData(VSSAVEFLAGS, String, Int32)

Saves the document data.
SetUntitledDocPath(String)

Sets the initial name (or path) for unsaved, newly created document data.

Applies to