This documentation is archived and is not being maintained.

IVsDocumentLockHolder Interface

Allows a non-editor to add an edit lock to an item registered in the running document table.

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

[GuidAttribute("685933F2-C1AD-4540-A15A-D3F977A81AF7")] 
[InterfaceTypeAttribute(1)] 
public interface IVsDocumentLockHolder
/** @attribute GuidAttribute("685933F2-C1AD-4540-A15A-D3F977A81AF7") */ 
/** @attribute InterfaceTypeAttribute(1) */ 
public interface IVsDocumentLockHolder
GuidAttribute("685933F2-C1AD-4540-A15A-D3F977A81AF7") 
InterfaceTypeAttribute(1) 
public interface IVsDocumentLockHolder

Implement this interface if you are implementing a wizard or another type of object that opens documents invisibly to the user—that is, if the document opens outside of a document window. By implementing IVsDocumentLockHolder, you can place an edit lock on a document in the running document table. This prevents an editor or another object from closing the file before you have finished editing it. To register a document lock holder, call RegisterDocumentLockHolder.

Notes to Implementers Implemented by any object that wants to edit a document without opening the document in an editor (that is, in a document window).

Notes to Callers Called by the environment to signal the closing of a document to the object implementing IVsDocumentLockHolder.

Show: