Share via


SubordinateDocumentLockHolder Class

Manages an edit lock on a subordinate file in the running documents table.

This API is not CLS-compliant. 

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Modeling.Shell.SubordinateDocumentLockHolder

Namespace:  Microsoft.VisualStudio.Modeling.Shell
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0.dll)

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public NotInheritable Class SubordinateDocumentLockHolder _
    Implements IVsDocumentLockHolder, IDisposable
[CLSCompliantAttribute(false)]
public sealed class SubordinateDocumentLockHolder : IVsDocumentLockHolder, 
    IDisposable
[CLSCompliantAttribute(false)]
public ref class SubordinateDocumentLockHolder sealed : IVsDocumentLockHolder, 
    IDisposable
[<Sealed>]
[<CLSCompliantAttribute(false)>]
type SubordinateDocumentLockHolder =  
    class 
        interface IVsDocumentLockHolder 
        interface IDisposable 
    end
public final class SubordinateDocumentLockHolder implements IVsDocumentLockHolder, IDisposable

The SubordinateDocumentLockHolder type exposes the following members.

Constructors

  Name Description
Public method SubordinateDocumentLockHolder Creates a new SubordinateDocumentLockHolder.

Top

Properties

  Name Description
Public property SubordinateDocData Retrieves the subordinate DocData managed by this lock holder.

Top

Methods

  Name Description
Public method CloseDocumentHolder Releases the lock on the subordinate document and unregisters the lock holder.
Public method Dispose Releases all resources used by the current instance of the SubordinateDocumentLockHolder class.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Finalizer (Overrides Object.Finalize().)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method ShowDocumentHolder Shows the first view associated with the parent document.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method UnregisterSubordinateDocument Unregisters the subordinate document and removes it from memory. This method does not save the document.

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio.Modeling.Shell Namespace