IVsDocumentLockHolder Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public interface class IVsDocumentLockHolder

public interface class IVsDocumentLockHolder

__interface IVsDocumentLockHolder

[System.Runtime.InteropServices.Guid("685933F2-C1AD-4540-A15A-D3F977A81AF7")]
[System.Runtime.InteropServices.InterfaceType(1)]
public interface IVsDocumentLockHolder

[System.Runtime.InteropServices.Guid("685933F2-C1AD-4540-A15A-D3F977A81AF7")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsDocumentLockHolder

[<System.Runtime.InteropServices.Guid("685933F2-C1AD-4540-A15A-D3F977A81AF7")>]
[<System.Runtime.InteropServices.InterfaceType(1)>]
type IVsDocumentLockHolder = interface

[<System.Runtime.InteropServices.Guid("685933F2-C1AD-4540-A15A-D3F977A81AF7")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IVsDocumentLockHolder = interface

Public Interface 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