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)

Syntax

'Declaration
<InterfaceTypeAttribute()> _
<GuidAttribute("685933F2-C1AD-4540-A15A-D3F977A81AF7")> _
Public Interface IVsDocumentLockHolder
'Usage
Dim instance As IVsDocumentLockHolder
[InterfaceTypeAttribute()]
[GuidAttribute("685933F2-C1AD-4540-A15A-D3F977A81AF7")]
public interface IVsDocumentLockHolder
[InterfaceTypeAttribute()]
[GuidAttribute(L"685933F2-C1AD-4540-A15A-D3F977A81AF7")]
public interface class IVsDocumentLockHolder
public interface IVsDocumentLockHolder

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.

See Also

Reference

IVsDocumentLockHolder Members

Microsoft.VisualStudio.Shell.Interop Namespace