SubordinateDocumentLockHolder Class

Article
2013-02-04

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.10.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.10.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
	SubordinateDocumentLockHolder	Creates a new SubordinateDocumentLockHolder.

Top

Properties

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

Top

Methods

	Name	Description
	CloseDocumentHolder	Releases the lock on the subordinate document and unregisters the lock holder.
	Dispose	Releases all resources used by the current instance of the SubordinateDocumentLockHolder class.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ShowDocumentHolder	Shows the first view associated with the parent document.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	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.

Share via