Workspace Class

Describes the properties and methods of a workspace. For more information about how to use this type, see Team Foundation Build Activities.

Inheritance Hierarchy

System.Object
Microsoft.TeamFoundation.VersionControl.Client.Workspace

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

Syntax

'Declaration
Public NotInheritable Class Workspace _
    Implements IComparable, IEqualityComparer(Of Workspace)
public sealed class Workspace : IComparable, 
    IEqualityComparer<Workspace>
public ref class Workspace sealed : IComparable, 
    IEqualityComparer<Workspace^>
[<Sealed>]
type Workspace =  
    class 
        interface IComparable 
        interface IEqualityComparer<Workspace>
    end
public final class Workspace implements IComparable, IEqualityComparer<Workspace>

The Workspace type exposes the following members.

Properties

Name Description
Public property Comment Gets the comment about the workspace.
Public property Computer Gets the name of the computer on which this workspace exists.
Public property DisambiguatedDisplayName This is the formatted display name of the workspace containing both the display and unique owner names.
Public property DisplayName Gets the formatted display name of the workspace.
Public property EffectivePermissions Gets the effective permissions that the AuthenticatedUser has on this workspace.
Public property Folders Gets the mappings for this workspace.
Public property HasAdministerPermission Gets a flag that indicates whether the AuthorizedUser has Administer permissions for this workspace.
Public property HasCheckInPermission Gets a flag that indicates whether the AuthorizedUser has CheckIn permissions for this workspace.
Public property HasReadPermission Gets a flag that indicates whether the AuthorizedUser has Read permissions for this workspace.
Public property HasUsePermission Gets a flag that indicates whether the AuthorizedUser has Use permissions for this workspace.
Public property IsDeleted Gets a flag that indicates whether this workspace has been deleted.
Public property IsLocal Gets a flag that indicates whether this workspace exists on the current computer.
Public property IsScannerAsynchronous This flag applies only to local workspaces (Location == WorkspaceLocation.Local). If true, then the VersionControlServer which owns this Workspace will raise the PendingChangesChanged and GetCompleted events as soon the disk scanner notices that something has changed on disk. That is, the generation of those events is truly asynchronous. If false, the disk scanner only runs when it is required for correctness -- as a part of calls to this Workspace object's public methods. The events will still raise, but they will raise after the scanned API call which notices them, instead of as soon as they occur on disk. The default is false. Setting this flag to true may decrease performance, but it is useful for the construction of a feature such as an always-up-to-date list of pending changes in the workspace.
Public property LastAccessDate Gets the date when this workspace was most recently accessed.
Public property LastSavedCheckin Gets or sets the metadata from the most recent unshelving or unsuccessful check-in.
Public property Location Indicates the location where data (pending changes, local versions) for this workspace are stored.
Public property MappingsAvailable Returns true if the working folders held by this Workspace object are believed to be current. If true, a call to perform mapping translations will not result in a server call.
Public property Name Gets the name of this workspace.
Public property OwnerAliases The aliases for the owner of this workspace excluding the display name or unique name.
Public property OwnerDescriptor Gets the IdentityDescriptor for the workspace owner, if it is available.
Public property OwnerDisplayName The owner's display name
Public property OwnerIdentifier Gets or sets the identifier of the owner of this workspace.
Public property OwnerIdentityType Gets or sets the identity type of the owner of this workspace.
Public property OwnerName Gets the owner of this workspace.
Public property PermissionsProfile Gets the effective permissions that the AuthenticatedUser has on this workspace.
Public property QualifiedName This is the formatted unique display name of the workspace.
Public propertyStatic member RepositoryComparer Gets a comparer for repositories that is culture-sensitive and case-insensitive.
Public property SecurityToken Gets the security token of this workspace for the workspace security namespace.
Public property VersionControlServer Gets the VersionControlServer object that hosts this workspace.
Public property WorkspaceOptions The options for the workspace (including the SetFileTimeToCheckin flag).

Top

Methods

Name Description
Public method AddIgnoreFileExclusion Adds an ignore file exclusion to the specified .tfignore file.
Public method AutoResolveValidConflicts Automatically resolves the conflict within the workspace using the available auto resolve options.
Public method CheckIn(WorkspaceCheckInParameters) Checks in the specified set of pending changes to the version-control repository.
Public method CheckIn(array<PendingChange[], String) Checks in the specified set of pending changes to the version-control repository.
Public method CheckIn(array<PendingChange[], String, CheckinNote, array<WorkItemCheckinInfo[], PolicyOverrideInfo) Checks in the specified set of pending changes to the version-control repository.
Public method CheckIn(array<PendingChange[], String, String, CheckinNote, array<WorkItemCheckinInfo[], PolicyOverrideInfo) Checks in the specified set of pending changes to the version-control repository.
Public method CheckIn(array<PendingChange[], String, String, CheckinNote, array<WorkItemCheckinInfo[], PolicyOverrideInfo, CheckinOptions) Checks in the specified set of pending changes to the version-control repository.
Public method Cloak Marks a file or folder in the version-control repository as being excluded from this workspace.
Public method CreateMapping Maps the specified server path to a location on the local disk.
Public method Delete Delete this workspace.
Public method DeleteMapping Removes a working-folder mapping from the workspace.
Public method Diff(array<ItemSpec[])
Public method Diff(array<ItemSpec[], array<String[], WorkspaceDifferenceFlags)
Public method Equals(Object) Compares this Workspace object to another Workspace object. (Overrides Object.Equals(Object).)
Public method Equals(Workspace, Workspace) Compares two Workspace objects for equivalence.
Public method EvaluateCheckin Evaluates the pending changes to verify whether they are ready for check-in.
Public method EvaluateCheckin2(CheckinEvaluationOptions, IEnumerable<PendingChange>, String, CheckinNote, array<WorkItemCheckinInfo[]) Evaluate the pending changes to verify whether they are ready to check in.
Public method EvaluateCheckin2(CheckinEvaluationOptions, IEnumerable<PendingChange>, IEnumerable<PendingChange>, String, CheckinNote, array<WorkItemCheckinInfo[]) Evaluate the pending changes to verify whether they are ready to check in.
Public method FormatWorkspaceNameForException Formats the conflicting workspace name for an exception when two names conflict.
Public method Get() Request the server to update the current workspace with the most recent versions of all mapped items.
Public method Get(GetRequest, GetOptions) Request that the server update the specified items.
Public method Get(array<GetRequest[], GetOptions) Request that the server update the specified items.
Public method Get(VersionSpec, GetOptions) Request that the server update the current workspace with the specified version of all mapped items.
Public method Get(array<String[], VersionSpec, RecursionType, GetOptions) Request that the server update the specified items.
Public method Get(GetRequest, GetOptions, GetFilterCallback, Object) Request that the server update the specified items.
Public method Get(array<GetRequest[], GetOptions, GetFilterCallback, Object) Request that the server update the specified items.
Public method Get(array<GetRequest[], GetOptions, GetFilterCallback, Object, array<String[]) Request that the server update the specified items.
Public method Get(array<GetRequest[], GetOptions, GetFilterCallback, Object, array<String[], array<Conflict[]%) Get requests that the server update the current workspace with the specified versions of the items. The filtering delegate allows the caller to discard operations before they are processed by setting the Ignore property on each operation to be discarded.
Public method Get(array<GetRequest[], GetOptions, GetFilterCallback, Object, array<String[], array<String[], array<Conflict[]%) Get requests that the server update the current workspace with the specified versions of the items. The filtering delegate allows the caller to discard operations before they are processed by setting the Ignore property on each operation to be discarded.
Public method GetExtendedItems(array<ItemSpec[], DeletedState, ItemType) Gets an array of extended items in the version-control repository that match the criteria that are specified in each ItemSpec.
Public method GetExtendedItems(array<ItemSpec[], DeletedState, ItemType, GetItemsOptions) Gets an array of extended items in the version-control repository that match the specified criteria, for each ItemSpec.
Public method GetExtendedItems(array<ItemSpec[], DeletedState, ItemType, GetItemsOptions, array<String[]) For each input ItemSpec, retrieves a list of extended items in the repository that match the specified criteria. If the 'path' argument is a file, returns a set of items that contain just that file. If the 'path' is a folder, returns a set of items that contain all items in that folder. If the 'path' contains a wildcard character, returns a set of items in the specified folder that match the wildcard.
Public method GetHashCode() Gets the hash code for this Workspace instance. (Overrides Object.GetHashCode().)
Public method GetHashCode(Workspace) Gets the hash code for the specified Workspace instance.
Public method GetItems For each provided ItemSpec, returns a corresponding WorkspaceItemSet containing data about items in the workspace.
Public method GetLocalItemForServerItem(String) Gets the corresponding local item for the specified server item.
Public method GetLocalItemForServerItem(String, Boolean) Gets the corresponding local item for the specified server item.
Public method GetLocalVersions Gets local item information about items in a workspace.
Public method GetPendingChanges() Gets the pending changes for this workspace.
Public method GetPendingChanges(String) Gets the pending changes for the specified item in this workspace.
Public method GetPendingChanges(array<String[]) Gets the pending changes for the items in this workspace.
Public method GetPendingChanges(array<ItemSpec[]) Gets the pending changes for these items and sub-items in this workspace.
Public method GetPendingChanges(String, RecursionType) Gets the pending changes for this item and sub-items in this workspace.
Public method GetPendingChanges(array<String[], RecursionType) Gets the pending changes for the items and sub-items in this workspace.
Public method GetPendingChanges(array<ItemSpec[], Boolean) Get the pending changes for specified items in this workspace.
Public method GetPendingChanges(String, RecursionType, Boolean) Gets the pending changes for this item and sub-items in this workspace.
Public method GetPendingChanges(array<String[], RecursionType, Boolean) Gets the pending changes for the items and sub-items in this workspace.
Public method GetPendingChanges(array<ItemSpec[], Boolean, Int32, String) Gets the pending changes for the items and sub-items in this workspace.
Public method GetPendingChanges(array<ItemSpec[], Boolean, Int32, String, Boolean) Gets the pending changes for the items and sub-items in this workspace.
Public method GetPendingChanges(array<ItemSpec[], Boolean, Int32, String, Boolean, array<String[]) Gets all of the pending changes for these items and potentially subitems in this workspace.
Public method GetPendingChangesEnumerable() Gets an enumerable collection of the pending changes for this workspace.
Public method GetPendingChangesEnumerable(String) Gets an enumerable collection of the pending changes for the specified item in this workspace.
Public method GetPendingChangesEnumerable(array<ItemSpec[]) Gets an enumerable collection of the pending changes for the items and sub-items in this workspace.
Public method GetPendingChangesEnumerable(String, RecursionType) Gets an enumerable collection of pending changes for this item and sub-items in this workspace.
Public method GetPendingChangesWithCandidates(array<ItemSpec[], Boolean, array<PendingChange[]%) Gets all of the pending changes and candidate changes.
Public method GetPendingChangesWithCandidates(array<ItemSpec[], Boolean, array<String[], array<PendingChange[]%) Gets all of the pending changes and candidate changes.
Public method GetServerItemForLocalItem Gets the corresponding server item for the specified local item.
Public method GetTeamProjectForLocalPath Gets the TeamProject instance that contains the specified path.
Public method GetTeamProjectsForLocalPaths Gets the team projects on the version-control repository that have the specified paths.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetWorkingFolderForLocalItem Gets a WorkingFolder instance that describes how the specified local item is mapped in the workspace.
Public method GetWorkingFolderForServerItem(String) Gets a WorkingFolder instance that describes how the specified server item is mapped in the workspace.
Public methodStatic member GetWorkingFolderForServerItem(String, array<WorkingFolder[]) Gets a WorkingFolder instance that describes how the specified server item is mapped in the workspace.
Public method HasWorkspacePermission Verifies whether the AuthorizedUser object has the specified WorkspacePermissions objects for this workspace.
Public method IsLocalPathMapped Verifies whether the specified local path is mapped and not cloaked.
Public method IsServerPathMapped(String) Returns true if the server item is mapped and not cloaked. This method may return a false positive for implicitly cloaked server paths.
Public method IsServerPathMapped(String, Boolean) Verifies whether the specified server item is mapped and not cloaked.
Public method Map Maps the specified server path to a location on the local disk.
Public methodStatic member MatchName Compares two workspace names.
Public methodStatic member MatchOwnerName Compares the names of two workspace owners.
Public method Merge(String, String, VersionSpec, VersionSpec) Merges the source to the target.
Public method Merge(ItemSpec, String, VersionSpec, VersionSpec, LockLevel, MergeOptionsEx) Merges the source to the target.
Public method Merge(String, String, VersionSpec, VersionSpec, LockLevel, RecursionType, MergeOptions) Merges the source to the target.
Public method Merge(String, String, VersionSpec, VersionSpec, LockLevel, RecursionType, MergeOptionsEx) Merges the source to the target.
Public method Merge(ItemSpec, String, VersionSpec, VersionSpec, LockLevel, MergeOptionsEx, array<String[]) Merges the source to the target.
Public method Merge(ItemSpec, String, VersionSpec, VersionSpec, LockLevel, MergeOptionsEx, array<String[], array<String[]) Performs a merge of the source to the target.
Public method MergeContent Merges content based on the requested conflict.
Public method OwnerNameMatches Returns true if the owner name matches any of the valid owner names for this workspace.
Public method PendAdd(String) Queues files or a folder for addition to the version-control repository.
Public method PendAdd(array<String[]) Queues files or folders for addition to the version-control repository.
Public method PendAdd(String, Boolean) Queues files, folders, and subitems for addition to the version-control repository.
Public method PendAdd(array<String[], Boolean) Queues files or folders for addition to the version-control repository.
Public method PendAdd(array<String[], Boolean, String, LockLevel) Queues files or folders for addition to the version-control repository.
Public method PendAdd(array<String[], Boolean, String, LockLevel, Boolean) Queues files or folders for addition to the version-control repository.
Public method PendAdd(array<String[], Boolean, String, LockLevel, Boolean, Boolean) Queues files or folders for addition to the version-control repository.
Public method PendAdd(array<String[], Boolean, String, LockLevel, Boolean, Boolean, Boolean) Queues files or folders for addition to the repository. This method can recurse through the specified path to queue subitems in addition to the items matched by the specified path.
Public method PendBranch(String, String, VersionSpec) Schedules a file or folder for branching.
Public method PendBranch(String, String, VersionSpec, LockLevel, Boolean) Schedules a file or folder for branching.
Public method PendBranch(String, String, VersionSpec, LockLevel, Boolean, Boolean) Schedules a file or folder for branching.
Public method PendBranch(String, String, VersionSpec, LockLevel, Boolean, Boolean, Boolean) Schedules a file or folder for branching.
Public method PendBranch(String, String, VersionSpec, LockLevel, Boolean, Boolean, Boolean, array<String[]) Schedules a file or folder for branching (branching occurs at check in). Branching a folder is implicitly recursive.
Public method PendDelete(String) Queues files or folders for deletion from the version-control repository.
Public method PendDelete(array<String[]) Queues files or folders for deletion from the version-control repository.
Public method PendDelete(String, RecursionType) Queues files or folders for deletion from the version-control repository.
Public method PendDelete(array<String[], RecursionType) Queues files or folders for deletion from the version-control repository.
Public method PendDelete(array<String[], RecursionType, LockLevel) Queues files or folders for deletion from the version-control repository.
Public method PendDelete(array<String[], RecursionType, LockLevel, Boolean) Queues files or folders for deletion from the version-control repository.
Public method PendDelete(array<String[], RecursionType, LockLevel, Boolean, Boolean) Queues files or folders for deletion from the version-control repository.
Public method PendDelete(array<String[], RecursionType, LockLevel, Boolean, Boolean, array<String[]) Queues files or folders for deletion from the version-control repository.
Public method PendDelete(array<String[], RecursionType, LockLevel, Boolean, Boolean, array<String[], array<String[]) Queues files or folders for deletion from the repository and deletes them in the local workspace. This method can recurse through the specified path to queue subitems in addition to the items matched by the specified path.
Public method PendEdit(String) Checks out files for editing from the version-control repository.
Public method PendEdit(array<String[]) Checks out files for editing from the version-control repository.
Public method PendEdit(String, RecursionType) Checks out files for editing from the version-control repository.
Public method PendEdit(array<String[], RecursionType) Checks out files for editing from the version-control repository.
Public method PendEdit(array<String[], RecursionType, String, LockLevel) Checks out files for editing from the version-control repository.
Public method PendEdit(array<String[], RecursionType, String, LockLevel, Boolean) Checks out files for editing from the version-control repository.
Public method PendEdit(array<String[], RecursionType, String, LockLevel, Boolean, PendChangesOptions) Checks out files for editing from the version-control repository.
Public method PendEdit(array<String[], RecursionType, String, LockLevel, Boolean, PendChangesOptions, array<String[]) Checks out files for editing from the version-control repository.
Public method PendEdit(array<String[], RecursionType, String, LockLevel, Boolean, PendChangesOptions, array<String[], array<String[]) Checks out files for editing from the repository. Note that fileSpec may have wildcard characters only in the last element of the path (e.g., c:\abc*z\def\xyz is not allowed, but c:\abc\def\*.cs is).
Public method PendPropertyChange(String, PropertyValue) Pends changes on the passed in path giving it the passed in properties.
Public method PendPropertyChange(String, PropertyValue, RecursionType, LockLevel) Pends changes on the passed in path giving it the passed in properties. Note, property changes are merged with existing properties on the server. To delete an existing property pass in a property that has the desired name and a value of null.
Public method PendPropertyChange(String, array<PropertyValue[], RecursionType, LockLevel) Pends changes on the passed in path giving it the passed in properties. Note, property changes are merged with existing properties on the server. To delete an existing property pass in a property that has the desired name and a value of null.
Public method PendPropertyChange(array<String[], PropertyValue, RecursionType, LockLevel) Pends changes on the passed in paths giving each of them the passed in property. Note, property changes are merged with existing properties on the server. To delete an existing property pass in a property that has the desired name and a value of null.
Public method PendPropertyChange(array<ItemProperties[], RecursionType, LockLevel, PendChangesOptions, array<String[], array<String[]) Pends changes on the passed in paths giving each of them the passed in properties. Note, property changes are merged with existing properties on the server. To delete an existing property pass in a property that has the desired name and a value of null.
Public method PendPropertyChange(array<String[], array<PropertyValue[], RecursionType, LockLevel, PendChangesOptions, array<String[], array<String[]) Pends changes on the passed in paths giving each of them the passed in properties. Note, property changes are merged with existing properties on the server. To delete an existing property pass in a property that has the desired name and a value of null.
Public method PendRename(String, String) Moves or renames a file or directory.
Public method PendRename(String, String, LockLevel, Boolean, Boolean) Moves or renames a file or directory.
Public method PendRename(String, String, LockLevel, Boolean, Boolean, Boolean) Moves or renames a file or directory.
Public method PendRename(String, String, LockLevel, Boolean, Boolean, PendChangesOptions, array<String[]) Moves or renames a file or directory. The source may contain wildcard characters if the target is a directory. The target may never have wildcard characters. If the target is an existing directory, the source will be moved to be a child of the target.
Public method PendRename(String, String, LockLevel, Boolean, Boolean, Boolean, array<String[]) Moves or renames a file or directory.
Public method PendRename(String, String, LockLevel, Boolean, Boolean, PendChangesOptions, array<String[], array<String[]) Moves or renames a file or directory. The source may contain wildcard characters if the target is a directory. The target may never have wildcard characters. If the target is an existing directory, the source will be moved to be a child of the target.
Public method PendUndelete(String, Int32) Queues deleted files or folders for restoration to the version-control repository.
Public method PendUndelete(String, Int32, String) Queues deleted files or folders for restoration to the version-control repository.
Public method PendUndelete(array<ItemSpec[], LockLevel, Boolean) Queues deleted files or folders for restoration to the version-control repository.
Public method PendUndelete(array<ItemSpec[], LockLevel, Boolean, Boolean) Queues deleted files or folders for restoration from the version-control repository.
Public method PendUndelete(String, Int32, String, LockLevel, Boolean) Queues deleted files or folders for restoration to the version-control repository.
Public method PendUndelete(array<ItemSpec[], LockLevel, Boolean, Boolean, Boolean) Queues deleted files or folders for restoration to the version-control repository.
Public method PendUndelete(String, Int32, String, LockLevel, Boolean, Boolean) Queues deleted files or folders for restoration to the version-control repository.
Public method PendUndelete(String, Int32, String, LockLevel, Boolean, Boolean, Boolean) Queues deleted files or folders for restoration to the version-control repository.
Public method PendUndelete(String, Int32, String, LockLevel, Boolean, Boolean, Boolean, array<String[]) Queues deleted files or folders for restoration to the version-control repository.
Public method PendUndelete(String, Int32, String, LockLevel, Boolean, Boolean, Boolean, array<String[], array<String[]) Queues files or folders for undeletion from the repository and optionally restores them in the current workspace.
Public method QueryConflicts Gets the array of conflicts that match the specified path filters.
Public method QueryPendingSets(array<ItemSpec[], String, String, Boolean) Gets the pending changes for the specified query.
Public method QueryPendingSets(array<String[], RecursionType, String, String, Boolean) Gets the pending changes for the specified query.
Public method QueryPendingSets(array<ItemSpec[], String, String, Boolean, array<String[]) Gets the pending changes for the specified query.
Public method QueryPendingSets(array<String[], RecursionType, String, String, Boolean, array<String[]) Gets the pending changes for the specified query.
Public method QueryShelvedChanges(String, String, array<ItemSpec[]) Gets the shelved changes for the specified query.
Public method QueryShelvedChanges(String, String, array<ItemSpec[], Boolean) Gets the shelved changes for the specified query.
Public method QueryShelvedChanges(String, String, array<ItemSpec[], Boolean, array<String[]) Gets the shelved changes for the specified query.
Public method QueueForEdit Marks the provided local item for check-out the next time we would make a call to the server. This method is only supported for server workspaces.
Public method Reconcile Reconciles a local workspace with the server.
Public method Refresh Refreshes this Workspace instance from the server.
Public method RefreshIfNeeded Refreshes this Workspace instance from the server if properties that cannot be cached are stale or have not been loaded. Properties that cannot be cached include working folders and effective permissions.
Public method RefreshMappings Obsolete. Gets the current set of mappings for this Workspace instance from the server.
Public method RemoveLocalConflict Removes a local conflict from the list of conflicts on the server for this workspace.
Public method RemoveLocalConflicts Removes local conflicts from the server's list of conflicts for this workspace.
Public method ResolveConflict(Conflict) Attempt to resolve a conflict based on its Resolution property.
Public method ResolveConflict(Conflict, array<Conflict[]%) Attempt to resolve a conflict based on its Resolution property.
Public method ResolveConflict(Conflict, array<Conflict[]%, array<String[]) Attempt to resolve a conflict based on its Resolution property.
Public method ResolveConflict(Conflict, array<Conflict[]%, array<String[], array<String[]) Attempts to resolve a conflict according to the conflict's Resolution property. If the conflict is successfully resolved, the IsResolved property will be true. If resolving this conflict caused other conflicts to be deleted besides the current conflict, then the list of other deleted conflicts will be returned in resolvedConflicts.
Public method ResolveConflicts(IEnumerable<Conflict>, array<String[], array<Conflict[]%) Attempts to resolve a conflict according to the conflict's Resolution property. If the conflict is successfully resolved, the IsResolved property will be true. If resolving these conflicts caused other conflicts to be deleted besides the current conflicts, then the list of other deleted conflicts will be returned in resolvedConflicts. Note: For this method, all resolution options for the conflicts must be the same.
Public method ResolveConflicts(IEnumerable<Conflict>, array<String[], array<String[], array<Conflict[]%) Attempts to resolve a conflict according to the conflict's Resolution property. If the conflict is successfully resolved, the IsResolved property will be true. If resolving these conflicts caused other conflicts to be deleted besides the current conflicts, then the list of other deleted conflicts will be returned in resolvedConflicts. Note: For this method, all resolution options for the conflicts must be the same.
Public method Rollback(VersionSpec, VersionSpec, LockLevel, RollbackOptions) Pends a rollback for all changes between the specified versions.
Public method Rollback(array<String[], RecursionType, VersionSpec, VersionSpec, VersionSpec, LockLevel, RollbackOptions, array<String[]) Pends a rollback for changes on a certain path, throughout the specified versions.
Public method Rollback(array<String[], RecursionType, VersionSpec, VersionSpec, VersionSpec, LockLevel, RollbackOptions, array<String[], array<String[]) Pends a rollback for changes which occurred to a certain path, in the specified versions
Public method SetLock(String, LockLevel) Applies the selected lock level to the specified path.
Public method SetLock(array<String[], LockLevel) Applies the selected lock level to the specified paths.
Public method SetLock(String, LockLevel, RecursionType) Applies the selected lock level to the specified path.
Public method SetLock(array<String[], LockLevel, RecursionType) Applies the selected lock level to the specified paths.
Public method SetLock(array<String[], LockLevel, RecursionType, Boolean) Applies the selected lock level to the specified paths.
Public method SetLock(array<String[], LockLevel, RecursionType, Boolean, array<String[]) Applies the selected lock level to the specified paths.
Public method SetLock(array<String[], LockLevel, RecursionType, Boolean, array<String[], array<String[]) Apply the selected lock level to the specified paths.
Public method SetPendingChangeAttribute Sets properties on existing pending changes
Public method SetPendingChangeProperty Obsolete. Sets properties on existing pending changes.
Public method Shelve Collects a set of pending changes and shelves them to the server.
Public method ToString Creates a user-readable string that describes the properties of this workspace. (Overrides Object.ToString().)
Public method TryGetLocalItemForServerItem(String) Gets the corresponding local item for the specified server item.
Public method TryGetLocalItemForServerItem(String, Boolean) Gets the corresponding local item for the specified server item.
Public method TryGetServerItemForLocalItem(String) Gets the corresponding server item for the specified local item. Does not throw exceptions.
Public methodStatic member TryGetServerItemForLocalItem(String, array<WorkingFolder[]) Gets the corresponding server item for the specified local item.
Public method TryGetServerItemForLocalItem(String, Boolean) Gets the corresponding server item for a local item. Does not throw ItemNotMappedException or ItemCloakedException.
Public methodStatic member TryGetServerItemForLocalItem(String, array<WorkingFolder[], Boolean) Gets the corresponding server item for a local item. Does not throw ItemNotMappedException or ItemCloakedException.
Public method TryGetWorkingFolderForLocalItem Gets a WorkingFolder instance that describes how the local item is mapped in the workspace.
Public method TryGetWorkingFolderForServerItem(String) Gets a WorkingFolder instance that describes how the specified WorkingFolder objects map the server item.
Public methodStatic member TryGetWorkingFolderForServerItem(String, array<WorkingFolder[]) Gets a WorkingFolder instance that describes how the specified WorkingFolder objects map the server item.
Public methodStatic member TryGetWorkingFolderForServerItem(String, array<WorkingFolder[], Boolean) Gets a WorkingFolder instance that describes how the specified WorkingFolder objects map the server item.
Public method Undo(String) Revert the pending changes for the specified item.
Public method Undo(array<String[]) Revert the pending changes for the specified items.
Public method Undo(array<ItemSpec[]) Revert the pending changes for the specified items.
Public method Undo(array<PendingChange[]) Revert the pending changes for the specified items.
Public method Undo(String, RecursionType) Revert the pending changes for the specified items.
Public method Undo(array<String[], RecursionType) Revert the pending changes for the specified items.
Public method Undo(array<String[], Boolean) Revert the pending changes for the specified items.
Public method Undo(array<ItemSpec[], Boolean) Revert the pending changes for the specified items.
Public method Undo(array<String[], RecursionType, Boolean) Revert the pending changes for the specified items.
Public method Undo(array<ItemSpec[], Boolean, array<String[]) Revert the pending changes for the specified items.
Public method Undo(array<ItemSpec[], Boolean, array<String[], array<String[]) Undo the pending changes for the specified items. The items may contain wildcard characters.
Public method Undo(array<ItemSpec[], Boolean, Boolean, array<String[], array<String[]) Undo the pending changes for the specified items. The items may contain wildcards.
Public method UnqueueForEdit Unmarks the provided local item for check-out the next time we would make a call to the server. This method is only supported for server workspaces.
Public method Unshelve(String, String) Reproduces in this workspace a set of pending changes that have been previously shelved to the server.
Public method Unshelve(String, String, array<ItemSpec[]) Reproduces in this workspace a set of pending changes that have been previously shelved to the server.
Public method Unshelve(String, String, array<ItemSpec[], array<PendingChange[]%) Reproduces in this workspace a set of pending changes that have been previously shelved to the server.
Public method Unshelve(String, String, array<ItemSpec[], array<PendingChange[]%, array<String[]) Reproduces in this workspace a set of pending changes that have been previously shelved to the server.
Public method Unshelve(String, String, array<ItemSpec[], array<String[], array<String[], array<String[], Boolean, Boolean, array<PendingChange[]%, array<Conflict[]%) Reproduces in this workspace a set of pending changes that have been previously shelved to the server.
Public method Update(UpdateWorkspaceParameters) Update a workspace using an UpdateWorkspaceParameters object as the source for update instructions. Only those properties on the UpdateWorkspaceParameters that you want to change must be populated.
Public method Update(String, String, array<WorkingFolder[]) Updates the properties of a workspace.
Public method Update(String, String, array<WorkingFolder[], Boolean) Update the properties of a workspace.
Public method Update(String, String, String, array<WorkingFolder[], Boolean) Updates the properties of a workspace.
Public method Update(String, String, String, String, array<WorkingFolder[], WorkspacePermissionProfile, Boolean) Updates the properties of a workspace.
Public method UpdateComputerName Updates the name of the computer in the repository.
Public method UpdateLastSavedCheckin(Shelveset) Updates the information from the most recent tried check-in with the information from the shelveset.
Public method UpdateLastSavedCheckin(Shelveset, array<PendingChange[]) Updates the information from the most recent tried check-in with the information from the shelveset and makes sure that the specified set of pending changes have a checked state set.

Top

Explicit Interface Implementations

Name Description
Explicit interface implemetationPrivate method IComparable.CompareTo Compares two workspace objects, comparing first the repository URLs, and then the workspace names, and finally the owners.

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