Share via

IVsPersistDocData2 Interface

  • Article

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("9D71890D-090C-4B67-80C3-4CB55C600B60")> _
Public Interface IVsPersistDocData2 _
    Inherits IVsPersistDocData

[InterfaceTypeAttribute()]
[GuidAttribute("9D71890D-090C-4B67-80C3-4CB55C600B60")]
public interface IVsPersistDocData2 : IVsPersistDocData

[InterfaceTypeAttribute()]
[GuidAttribute(L"9D71890D-090C-4B67-80C3-4CB55C600B60")]
public interface class IVsPersistDocData2 : IVsPersistDocData

[<InterfaceTypeAttribute()>]
[<GuidAttribute("9D71890D-090C-4B67-80C3-4CB55C600B60")>]
type IVsPersistDocData2 =  
    interface
        interface IVsPersistDocData
    end

public interface IVsPersistDocData2 extends IVsPersistDocData

The IVsPersistDocData2 type exposes the following members.

Methods

  Name Description
Public method Close Closes the IVsPersistDocData2 object.
Public method GetGuidEditorType Returns the unique identifier of the editor factory that created the IVsPersistDocData2 object.
Public method IsDocDataDirty Determines whether the document data has changed since the last save.
Public method IsDocDataReadOnly Determines whether the document data is read-only.
Public method IsDocDataReloadable Determines whether the document data can be reloaded.
Public method LoadDocData Loads the document data from a given MkDocument.
Public method OnRegisterDocData Called by the Running Document Table (RDT) when it registers the document data in the RDT.
Public method ReloadDocData Reloads the document data and in the process determines whether to ignore a subsequent file change.
Public method RenameDocData Renames the document data.
Public method SaveDocData Saves the document data.
Public method SetDocDataDirty Sets the IsDirty flag to true.
Public method SetDocDataReadOnly Sets the Read-Only flag to true.
Public method 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.

Notes to Implementers

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

See Also

Reference

Microsoft.VisualStudio.Shell.Interop Namespace