IVsDocumentLockHolder Interface

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.13.40008

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

C++/CX

public interface class IVsDocumentLockHolder

Derived

Microsoft.VisualStudio.Modeling.Shell.SubordinateDocumentLockHolder

Microsoft.VisualStudio.Shell.Design.Serialization.DocData

Attributes

GuidAttribute InterfaceTypeAttribute

Remarks

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.

Methods

CloseDocumentHolder(UInt32)	Called when the environment closes a document with an IVsDocumentLockHolder entry in the running document table.
ShowDocumentHolder()	Called by the environment before prompting the user to save the invisible document locked by the holder.

Applies to