VersionControlLabelDocumentItem Class

Represents an item in a VersionControlLabelDocument

Inheritance Hierarchy

System.Object
Microsoft.VisualStudio.TeamFoundation.VersionControl.VersionControlLabelDocumentItem

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

Syntax

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

The VersionControlLabelDocumentItem type exposes the following members.

Properties

Name Description
Public property CheckinDate If Exists is true, this property will be non-null. The DateTime when Version was committed to the server.
Public property Committed If false, this item has not been saved to the server yet and is a "pending change" to this label.
Public property Exists Always true for files. For folders, this will be false if the item does not occur in the label, but occurs in our tree view of the label in order to serve as a parent to children that are actually in the label. In the UI these nodes are shown greyed-out and for some properties in the tree view, show "Not in label"
Public property Item If Exists is true, this property will be non-null. The Item object for this item in the label.
Public property ItemType The ItemType of this item (file or folder)
Public property ServerPath The server path of this item.
Public property Version If Exists is true, this property will be non-null. The changeset number of the item as it is in the label.

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 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