Item Class

Represents a committed version of a file or folder in the version control server.

Inheritance Hierarchy

System.Object
Microsoft.TeamFoundation.VersionControl.Client.Item
Microsoft.TeamFoundation.VersionControl.Client.WorkspaceItem

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

Syntax

'Declaration
Public Class Item
public class Item
public ref class Item
type Item =  class end
public class Item

The Item type exposes the following members.

Properties

Name Description
Public property ArtifactUri Gets the artifact uniform resource identifier (URI).
Public property ArtifactUriLatestItemVersion Gets the latest version artifact URI.
Public property Attributes Gets the attributes associated with the item.
Public property ChangesetId Gets the changeset ID of this item.
Public property CheckinDate Gets the check-in date of this item.
Public propertyStatic member Comparer Gets a Comparer object for Version Control server paths.
Public property ContentLength Gets the length of the content in this item.
Public property DeletionId Gets the deletion ID of this item.
Public property Encoding Gets the encoding of this item.
Public property HashValue Gets the hash value of this item.
Public property IsBranch Flag that describes whether this item is a branch.
Public property IsContentDestroyed Gets a flag that describes whether the content of the item was destroyed.
Public property ItemId Gets the ID of this item.
Public property ItemType Gets the type of this item.
Public property Properties Obsolete. Gets a read-only collection of properties that is associated with the item.
Public property PropertyValues Gets the property values associated with the item.
Public property ServerItem Gets the path of the associated item on the server.
Public property VersionControlServer Gets the version control repository that contains this item.

Top

Methods

Name Description
Public method DownloadFile() Downloads the content for this version of the item.
Public method DownloadFile(String) Downloads the content for this version of the item.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (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.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Creates a user-readable string that displays relevant properties of this item. (Overrides Object.ToString().)

Top

Fields

Name Description
Protected field m_changesetId Represents the changeset identifier of the item.
Protected field m_checkinDate Represents the checkin date it the item.
Protected field m_contentLength Represents the content length of the item.
Protected field m_deletionId Represents the deletion identifier of the item.
Protected field m_downloadUrl Represents the download URL associated with the item.
Protected field m_encoding Represents the encoding of the item.
Protected field m_isBranch Represents whether the item is a branch.
Protected field m_itemId Represents the identifier of the item.
Protected field m_itemType Represents the type of the item.
Protected field m_serverItem Represents the server associated with the item.
Protected field m_timeZone Represents the time zone of the item.
Protected field m_timeZoneOffset Represents the time zone offset of the item.

Top

Remarks

The item path is always a server path. It is returned by GetItems(), GetItem(), and several other calls.

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