IVsDocDataFileChangeControl Interface

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Determines whether changes to document data files made outside of the editor should be ignored.

public interface class IVsDocDataFileChangeControl

public interface class IVsDocDataFileChangeControl

__interface IVsDocDataFileChangeControl

[System.Runtime.InteropServices.Guid("BF955013-A875-439D-A4E7-A3BBDF12AA4F")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsDocDataFileChangeControl

[<System.Runtime.InteropServices.Guid("BF955013-A875-439D-A4E7-A3BBDF12AA4F")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IVsDocDataFileChangeControl = interface

Public Interface IVsDocDataFileChangeControl

Derived

Microsoft.VisualStudio.Modeling.Shell.DocData

Attributes

GuidAttribute InterfaceTypeAttribute

Remarks

All editors should implement LoadDocData. This means that the editor advises for file change events through SVsFileChangeEx to listen for changes to the file outside of the environment. The editor would then prompt the user to reload the file. See AdviseFileChange for information relating to advising for file changes.

All editors that properly implement this reload feature need to implement IVsDocDataFileChangeControl to allow listeners like Source Code Control to tell the editor to ignore file changes at specific times. For example, when Source Code Control is getting the latest version of the file it will directly call ReloadDocData at the appropriate time rather than allowing the user to be prompted to reload the file.

Methods

IgnoreFileChanges(Int32)

Determines whether changes to DocData in files should be ignored.