WorkspaceItem Class

Used by QueryWorkspaceItems to represent an item.

Inherits all fields from Item.

Inheritance Hierarchy

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

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

Syntax

'Declaration
<RequiredClientServiceAttribute("VersionControlServer")> _
Public Class WorkspaceItem _
    Inherits Item
[RequiredClientServiceAttribute("VersionControlServer")]
public class WorkspaceItem : Item
[RequiredClientServiceAttribute(L"VersionControlServer")]
public ref class WorkspaceItem : public Item
[<RequiredClientServiceAttribute("VersionControlServer")>]
type WorkspaceItem =  
    class 
        inherit Item 
    end
public class WorkspaceItem extends Item

The WorkspaceItem type exposes the following members.

Constructors

  Name Description
Public method WorkspaceItem

Top

Properties

  Name Description
Public property Attributes Attributes (Inherited from Item.)
Public property ChangesetId The version number of this item as a changeset number. (Inherited from Item.)
Public property ChangeType
Public property CheckinDate Last modification timestamp of the item. (Inherited from Item.)
Public property CommittedServerItem
Public property DeletionId Since more than one deleted item may exist with the same ServerItem name, this is used to uniquely identify deleted items. ServerItem + DeletionId is guaranteed to be unique for all items. (Inherited from Item.)
Public property DownloadUrl Returns the download URL fragment of the file to download. (Inherited from Item.)
Public property Encoding (Inherited from Item.)
Public property FileLength Length of item, if applicable (Inherited from Item.)
Public property HashValue MD5 of item, if applicable (Inherited from Item.)
Public property IsBranch Where the item is defined as a branch object in the system. (Inherited from Item.)
Public property IsContentDestroyed (Inherited from Item.)
Public property IsFolder (Inherited from Item.)
Public property ItemId The item's ID. Used to retrieve file contents (Inherited from Item.)
Public property ItemType This tells the client the type of item being referenced. (Inherited from Item.)
Public property LocalItem Path to the item on the client's local disk.
Public property Properties Obsolete. Properties (Inherited from Item.)
Public property PropertyValues Properties (Inherited from Item.)
Public property RecursiveChangeType
Public property SequenceId (Inherited from Item.)
Public property ServerItem Repository path of this item (e.g. $/Sample/MyFile.cs) (Inherited from Item.)
Public property TimeZone The timezone name in effect on the checkin date (Inherited from Item.)
Public property TimeZoneOffset The timezone offset in effect on the checkin date (Inherited from Item.)

Top

Methods

  Name Description
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 GetArtifactSpec (Inherited from Item.)
Public method GetCachedSize Average size in bytes of the item. (Inherited from Item.)
Public method GetDownloadUrlCount (Inherited from Item.)
Public method GetFileId (Inherited from Item.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetHashValue (Inherited from Item.)
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 SetDownloadUrl (Inherited from Item.)
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.TeamFoundation.VersionControl.Server Namespace