Share via


Workspace Members

Include Protected Members
Include Inherited Members

Handler for Workspace changes.

The Workspace type exposes the following members.

Methods

 

Name

Description

Public method

CheckIn

Overloaded. Checks in a set of pending changes.

Public method

Cloak

Marks a file or folder in the database as being excluded from this workspace.

Public method

CreateMapping

Adds a working file or folder mapping that associates the specified server path with a location on the local disk.

Public method

Delete

Deletes this workspace.

Public method

DeleteMapping

Removes the mapping of a working folder from the workspace.

Public method

Equals

Overloaded. Returns true if the WorkspaceInfo objects are equal according to database, name, and owner.

Public method

EvaluateCheckin

Evaluates a set of pending changes to see whether they are ready to check in.

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

FormatWorkspaceNameForException

Formats the conflicting workspace name for exception when there is a conflict. The owner of the workspace is included when the owner is different.

Public method

Get

Overloaded. Requests that the server update the current workspace with the latest version of all mapped items.

Public method

GetExtendedItems

For each input ItemSpec, retrieves a list of extended items in the database that match the specified criteria.

Public method

GetHashCode

Overloaded. Returns the hash code.

Public method

GetLocalItemForServerItem

Gets the local item path for a server item path.

Public method

GetPendingChanges

Overloaded. Gets pending changes.

Public method

GetServerItemForLocalItem

Gets the server item path for a local item path.

Public method

GetTeamProjectForLocalPath

Finds and returns the TeamProject in which a given localPath resides.

Public method

GetTeamProjectsForLocalPaths

Gets the team projects in the database with the specified paths.

Public method

GetType

Gets the type of the current instance. (Inherited from Object.)

Public method

GetWorkingFolderForLocalItem

Returns a working folder that has the mapping for the local item.

Public methodStatic member

GetWorkingFolderForServerItem

Overloaded. Returns a working folder that has the mapping for the server item.

Public method

IsLocalPathMapped

Returns true if the local path is mapped and not cloaked.

Public method

IsServerPathMapped

Returns true if the server path is mapped and not cloaked.

Public method

Map

Adds a working file or folder mapping associating the specified server path with a location on the local disk.

Public methodStatic member

MatchName

Compares two workspace names and returns true if they match. Comparisons are case insensitive.

Public methodStatic member

MatchOwnerName

Compares two workspace owners and returns true if they match. Comparisons are case insensitive.

Protected method

MemberwiseClone

Creates a shallow copy of the current Object. (Inherited from Object.)

Public method

Merge

Overloaded. Performs a merge of the source to the target.

Public method

MergeContent

Performs a content merge based on the requested conflict.

Public method

PendAdd

Overloaded. Queues files or folders for addition to the database.

Public method

PendBranch

Overloaded. Schedules a file or folder for branching.

Public method

PendDelete

Overloaded. Queues files or folders for deletion from the database.

Public method

PendEdit

Overloaded. Checks out files for editing from the database.

Public method

PendRename

Overloaded. Moves or renames a file or directory.

Public method

PendUndelete

Overloaded. Queues files or folders for undeletion from the database and optionally restores them in the current workspace.

Public method

QueryConflicts

Gets the list of conflicts that match the specified path filters. The source and target local and server paths for each conflict are matched against the specified paths.

Public method

QueryPendingSets

Overloaded. Gets the pending changes for the specified query.

Public method

QueryShelvedChanges

Overloaded. Gets the shelved changes for the specified query.

Public method

RefreshMappings

Gets from the server the current set of mappings for this workspace.

Public method

RemoveLocalConflict

Removes a local conflict from the server's list of conflicts for this workspace.

Public method

ResolveConflict

Overloaded.

Public method

SetLock

Overloaded. Apply the selected lock level to the specified path or paths.

Public method

Shelve

Collects a set of pending changes and shelves them to the server. Shelved changes can be later reproduced as pending changes in this or another workspace.

Public method

ToString

(Overrides Object.ToString().)

Public method

TryGetLocalItemForServerItem

Gets the local item path for a server item path. This method does not throw ItemNotMappedException or ItemCloakedException.

Public method

TryGetServerItemForLocalItem

Gets the server item path for a local item path. This method does not throw ItemNotMappedException or ItemCloakedException.

Public method

TryGetWorkingFolderForLocalItem

Returns a working folder that has the mapping for the local item.

Public methodStatic member

TryGetWorkingFolderForServerItem

Overloaded. Returns a working folder that has the mapping for the server item.

Public method

Undo

Overloaded. Undo the pending changes for the specified item or items. The item or items may contain wildcard characters.

Public method

Unshelve

Overloaded. Reproduces in this workspace a set of pending changes that have been previously shelved to the server.

Public method

Update

Update a workspace. The name, comment, and working folders may be changed. The database is the one referenced by changedWorkspace (workspaces cannot be moved across databases).

Public method

UpdateComputerName

Update the name of the computer in the database.

Public method

UpdateLastSavedCheckin

Overloaded. Updates the last attempted check-in information with the information from the shelveset.

Top

Properties

 

Name

Description

Public property

Comment

Gets the comment which describes the Workspace. May be empty or nulla null reference (Nothing in Visual Basic).

Public property

Computer

Gets the name of the computer to which this Workspace belongs.

Public property

DisplayName

Gets the formatted display name of the Workspace.

Public property

Folders

Gets the mappings for this Workspace.

Public property

IsDeleted

Gets or sets the flag that indicates whether the Workspace has been deleted.

Public property

IsLocal

Gets the flag that indicates whether the workspace resides on the local computer.

Public property

LastAccessDate

Gets the time of the last access to the server.

Public property

LastSavedCheckin

Gets or sets the metadata for the last unsuccessful check-in or the metadata from unshelving.

Public property

Name

Gets the Workspace name.

Public property

OwnerName

Gets the name of the user who owns this Workspace.

Public propertyStatic member

RepositoryComparer

Gets the database comparer. This is culture sensitive and case insensitive.

Public property

VersionControlServer

Gets or sets the VersionControlServer object that hosts this workspace.

Top

Explicit Interface Implementations

 

Name

Description

Explicit interface implemetationPrivate method

IComparable.CompareTo

Top

See Also

Reference

Workspace Class

Microsoft.TeamFoundation.VersionControl.Client Namespace