VersionControlLabelExt Class

Inheritance Hierarchy

System.Object
Microsoft.VisualStudio.TeamFoundation.VersionControl.VersionControlBaseExt
Microsoft.VisualStudio.TeamFoundation.VersionControl.VersionControlLabelExt

Namespace: Microsoft.VisualStudio.TeamFoundation.VersionControl
Assembly: Microsoft.VisualStudio.TeamFoundation.VersionControl (in Microsoft.VisualStudio.TeamFoundation.VersionControl.dll)

Syntax

'Declaration
Public NotInheritable Class VersionControlLabelExt _
    Inherits VersionControlBaseExt
public sealed class VersionControlLabelExt : VersionControlBaseExt
public ref class VersionControlLabelExt sealed : public VersionControlBaseExt
[<Sealed>]
type VersionControlLabelExt =  
    class 
        inherit VersionControlBaseExt 
    end
public final class VersionControlLabelExt extends VersionControlBaseExt

The VersionControlLabelExt type exposes the following members.

Properties

Name Description
Public property ActiveWindow Gets the most recently used Label document window. This will return null if there is no active window.
Public property WindowList Returns an array of objects each representing an Label document window.

Top

Methods

Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
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 OpenLabel(String) Opens a new label document window, given a label URI of the form "vstfs://VersionControl/Label/#", where # is the LabelId.
Public method OpenLabel(String, String, String) Opens a new label document window, given the name, scope, and owner of the label. This method may throw a LabelNotFoundException or LabelNotUniqueException, among others.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Events

Name Description
Public event SelectionChanged This event is fired when the selection changes in a version control window. (Inherited from VersionControlBaseExt.)
Public event WindowChanged Raised when a label document window has finished loading its content.
Public event WindowClosing Raised when a label document window is created.
Public event WindowCreated Raised when a label document window is created. The label will not have its metadata populated yet. Therefore, it will be impossible to know the name, owner, and so on of the label. It is more common to listen for the LabelMetadataAvailable event instead of this one.

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.TeamFoundation.VersionControl Namespace