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)

public interface IVsDocumentLockHolder

The IVsDocumentLockHolder type exposes the following members.

Public methodCloseDocumentHolderCalled when the environment closes a document with an IVsDocumentLockHolder entry in the running document table.
Public methodShowDocumentHolderCalled by the environment before prompting the user to save the invisible document locked by the holder.

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.