WorkspaceItem Class

Used by QueryWorkspaceItems to represent an item.

Inherits all fields from Item.

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 NotInheritable Class WorkspaceItem _
    Inherits Item
public sealed class WorkspaceItem : Item
public ref class WorkspaceItem sealed : public Item
[<Sealed>]
type WorkspaceItem =  
    class 
        inherit Item 
    end
public final class WorkspaceItem extends Item

The WorkspaceItem type exposes the following members.

Properties

  Name Description
Public property ArtifactUri Gets the artifact uniform resource identifier (URI). (Inherited from Item.)
Public property ArtifactUriLatestItemVersion Gets the latest version artifact URI. (Inherited from Item.)
Public property Attributes Gets the attributes associated with the item. (Inherited from Item.)
Public property ChangesetId Gets the changeset ID of this item. (Inherited from Item.)
Public property ChangeType Gets the type of change that applied to an item.
Public property CheckinDate Gets the check-in date of this item. (Inherited from Item.)
Public property CommittedServerItem Gets the committed server item at which to start the query.
Public property ContentLength Gets the length of the content in this item. (Inherited from Item.)
Public property DeletionId Gets the deletion ID of this item. (Inherited from Item.)
Public property Encoding Gets the encoding of this item. (Inherited from Item.)
Public property HashValue Gets the hash value of this item. (Inherited from Item.)
Public property IsBranch Flag that describes whether this item is a branch. (Inherited from Item.)
Public property IsContentDestroyed Gets a flag that describes whether the content of the item was destroyed. (Inherited from Item.)
Public property ItemId Gets the ID of this item. (Inherited from Item.)
Public property ItemType Gets the type of this item. (Inherited from Item.)
Public property LocalItem Gets the path to the item on the client's local disk.
Public property Properties Obsolete. Gets a read-only collection of properties that is associated with the item. (Inherited from Item.)
Public property PropertyValues Gets the property values associated with the item. (Inherited from Item.)
Public property RecursiveChangeType Gets the change type to apply during recursion.
Public property ServerItem Gets the path of the associated item on the server. (Inherited from Item.)
Public property VersionControlServer Gets the version control repository that contains this item. (Inherited from Item.)

Top

Methods

  Name Description
Public method DownloadFile() Downloads the content for this version of the item. (Inherited from Item.)
Public method DownloadFile(String) Downloads the content for this version of the item. (Inherited from Item.)
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 the string representation of the workspace item. (Overrides Item.ToString().)

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