This documentation is archived and is not being maintained.

VersionControlLabelExt Class


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

public sealed class VersionControlLabelExt : VersionControlBaseExt

The VersionControlLabelExt type exposes the following members.

Public propertyActiveWindowGets the most recently used Label document window. This will return null if there is no active window.
Public propertyWindowListReturns an array of objects each representing an Label document window.

Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodOpenLabel(String)Opens a new label document window, given a label URI of the form "vstfs://VersionControl/Label/#", where # is the LabelId.
Public methodOpenLabel(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 methodToStringReturns a string that represents the current object. (Inherited from Object.)

Public eventSelectionChangedThis event is fired when the selection changes in a version control window. (Inherited from VersionControlBaseExt.)
Public eventWindowChangedRaised when a label document window has finished loading its content.
Public eventWindowClosingRaised when a label document window is created.
Public eventWindowCreatedRaised 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.

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