Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

IVsDocDataFileChangeControl Interface

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

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in microsoft.visualstudio.shell.interop.dll)

[GuidAttribute("BF955013-A875-439D-A4E7-A3BBDF12AA4F")] 
[InterfaceTypeAttribute(1)] 
public interface IVsDocDataFileChangeControl
/** @attribute GuidAttribute("BF955013-A875-439D-A4E7-A3BBDF12AA4F") */ 
/** @attribute InterfaceTypeAttribute(1) */ 
public interface IVsDocDataFileChangeControl
GuidAttribute("BF955013-A875-439D-A4E7-A3BBDF12AA4F") 
InterfaceTypeAttribute(1) 
public interface IVsDocDataFileChangeControl

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.

See illustrations of the implementation and/or calling of this interface in the Basic Edit Overview, Basic Project Sample, Figures Project Sample, and My C Package Sample samples.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.