Share via


WorkingFolder Class

Represents a working folder setting.

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.VersionControl.Client.Mapping
    Microsoft.TeamFoundation.VersionControl.Client.WorkingFolder

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

Syntax

'Declaration
Public NotInheritable Class WorkingFolder _
    Inherits Mapping _
    Implements ICloneable
public sealed class WorkingFolder : Mapping, 
    ICloneable
public ref class WorkingFolder sealed : public Mapping, 
    ICloneable
[<Sealed>]
type WorkingFolder =  
    class 
        inherit Mapping 
        interface ICloneable 
    end
public final class WorkingFolder extends Mapping implements ICloneable

The WorkingFolder type exposes the following members.

Constructors

  Name Description
Public method WorkingFolder(String, String) Initializes a new working folder object that represents a mapping of serverItem to localItem.
Public method WorkingFolder(String, String, WorkingFolderType) Creates a working folder object.
Public method WorkingFolder(String, String, WorkingFolderType, RecursionType) Creates a working folder object.

Top

Properties

  Name Description
Public property Depth Gets the recursion type for the mapping. (Inherited from Mapping.)
Public property DisplayServerItem Gets the display string for a server item. (Inherited from Mapping.)
Public property IsCloaked Gets a flag that describes whether this mapping is a cloak.
Public property LocalItem Gets the local folder for this item map.
Public propertyStatic member LocalItemComparer Comparer to sort WorkingFolder instances that are based on a local path.
Public property ServerItem Gets the path of the server item that is associated with this mapping. (Inherited from Mapping.)
Public propertyStatic member ServerItemComparer Comparer to sort WorkingFolder instances that are based on a server path.
Public property Type Gets the type of the mapped working folder. (Inherited from Mapping.)

Top

Methods

  Name Description
Public methodStatic member AreSetsEqual Returns true if two sets of WorkingFolders are identical.
Public method Clone Creates a copy of this WorkingFolder instance.
Public method Equals Compare this instance to another WorkingFolder instance for equality. (Overrides Mapping.Equals(Object).)
Public method GetHashCode Generates a hash code for this instance. (Overrides Mapping.GetHashCode().)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public methodStatic member GetWorkspaceRoots Defines the collections of workspace roots from the working folders.
Public method ToString Describes this WorkingFolder object in a user-readable string. (Overrides Mapping.ToString().)

Top

Operators

  Name Description
Public operatorStatic member Equality Compares two WorkingFolder instances for equality.
Public operatorStatic member Inequality Compares two WorkingFolder instances for inequality.

Top

Fields

  Name Description
Public fieldStatic member DepthOneString Returns the string which represents a one depth mapping.

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