VersionControlLabelDocument Class

Inheritance Hierarchy

System.Object
Microsoft.VisualStudio.TeamFoundation.VersionControl.VersionControlLabelDocument

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

Syntax

'Declaration
Public NotInheritable Class VersionControlLabelDocument
public sealed class VersionControlLabelDocument
public ref class VersionControlLabelDocument sealed
[<Sealed>]
type VersionControlLabelDocument =  class end
public final class VersionControlLabelDocument

The VersionControlLabelDocument type exposes the following members.

Properties

Name Description
Public property ArtifactUri The artifact URI for this label
Public property Comment The comment of this label
Public property CurrentFolder The current folder in the label document that is shown in the right pane (ListView) and selected in the left pane (TreeView). To set this, use the Navigate() method.
Public property IsBusy True if the label's asynchronous load is in progress.
Public property IsDirty The dirty bit for this label. True if the label must be saved before it is closed.
Public property LabelId The LabelId for this label
Public property MetadataAvailable True if the label's metadata load is completed. These are the LabelId, Name, Owner, Scope, Comment, and ArtifactUri properties.
Public property Name The name of this label
Public property OwnerName The owner of this label
Public property Scope The scope of this label
Public property SelectedItems The selected items in the Label document window. These items may be sourced from the TreeView on the left or the ListView on the right, depending on where the keyboard focus is or last was.
Public property VsWindowFrame Get the IVsWindowFrame for this document window.

Top

Methods

Name Description
Public method Close Closes this Label document window.
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 Navigate Navigate the label to the given server path.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

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