IVsPersistDocData2 Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public interface class IVsPersistDocData2 : Microsoft::VisualStudio::Shell::Interop::IVsPersistDocData

public interface class IVsPersistDocData2 : Microsoft::VisualStudio::Shell::Interop::IVsPersistDocData

__interface IVsPersistDocData2 : Microsoft::VisualStudio::Shell::Interop::IVsPersistDocData

[System.Runtime.InteropServices.Guid("9D71890D-090C-4B67-80C3-4CB55C600B60")]
[System.Runtime.InteropServices.InterfaceType(1)]
public interface IVsPersistDocData2 : Microsoft.VisualStudio.Shell.Interop.IVsPersistDocData

[System.Runtime.InteropServices.Guid("9D71890D-090C-4B67-80C3-4CB55C600B60")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsPersistDocData2 : Microsoft.VisualStudio.Shell.Interop.IVsPersistDocData

[<System.Runtime.InteropServices.Guid("9D71890D-090C-4B67-80C3-4CB55C600B60")>]
[<System.Runtime.InteropServices.InterfaceType(1)>]
type IVsPersistDocData2 = interface
    interface IVsPersistDocData

[<System.Runtime.InteropServices.Guid("9D71890D-090C-4B67-80C3-4CB55C600B60")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IVsPersistDocData2 = interface
    interface IVsPersistDocData

Public Interface IVsPersistDocData2
Implements IVsPersistDocData

Derived: Microsoft.VisualStudio.Modeling.Shell.DocData

Attributes: GuidAttribute InterfaceTypeAttribute

Implements: IVsPersistDocData

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.

Notes to Implementers

Implement IVsPersistDocData2 in collaboration with the text buffer when needing to persist document data.

Methods

Close()	Closes the IVsPersistDocData2 object.
GetGuidEditorType(Guid)	Returns the unique identifier of the editor factory that created the IVsPersistDocData2 object.
IsDocDataDirty(Int32)	Determines whether the document data has changed since the last save.
IsDocDataReadOnly(Int32)	Determines whether the document data is read-only.
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.
SetDocDataDirty(Int32)	Sets the IsDirty flag to true.
SetDocDataReadOnly(Int32)	Sets the Read-Only flag to `true`.
SetUntitledDocPath(String)	Sets the initial name (or path) for unsaved, newly created document data.

Applies to

Share via