Share via

PendingChange Class

  • Article

Represents a change that has not been committed to the repository.

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.VersionControl.Client.PendingChange

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

Syntax

'Declaration
Public NotInheritable Class PendingChange

public sealed class PendingChange

public ref class PendingChange sealed

[<Sealed>]
type PendingChange =  class end

public final class PendingChange

The PendingChange type exposes the following members.

Properties

  Name Description
Public property ChangeType Gets the ChangeType of this pending change.
Public property ChangeTypeName Gets the localized name of the change type.
Public property ConflictType Gets the type of conflict against this change. This is only populated for queries against local workspaces.
Public property CreationDate Gets the date that the change was pending.
Public property DeletionId Gets the ID of the item to be deleted.
Public propertyStatic member EmptyIEnumerable Gets an empty IEnumerable of PendingChanges.
Public property Encoding Gets the encoding of the file.
Public property EncodingName Gets the localized name of the encoding.
Public property FileName Gets the file name for this pending change from the local path. Gets the file name from the server path if the local path is unavailable.
Public property HashValue Gets the MD5 HashValue for the contents of the pending change.
Public property IsAdd Gets a flag that describes whether this pending change is a pending add.
Public property IsBranch Gets a flag that describes whether this change is a pending branch.
Public property IsCandidate Gets a value that indicates whether the change is a candidate.
Public property IsDelete Gets a flag that describes whether this pending change is a pending delete.
Public property IsEdit Gets a flag that describes whether this pending change is a pending edit.
Public property IsEncoding Gets a flag that describes whether this pending change is a pending file type change.
Public property IsImplicit Gets a value that indicates whether this pending change represents change on the child item caused only by the parent change.
Public property IsLocalItemDelete Gets a flag that describes whether the pending change is deleting a local file or folder.
Public property IsLock Gets a flag that describes whether this pending change has a lock.
Public property IsMerge Gets a flag that describes whether this change is a pending merge.
Public property IsRename Gets a flag that describes whether this pending change is a pending rename.
Public property IsRollback Gets a flag that describes whether this change is a pending rollback.
Public property IsUndelete Gets a flag that describes whether this changes is a pending undelete.
Public property IsUnshelvedChange Gets a flag that describes whether this pending change is from unshelving a shelveset.
Public property ItemId Gets the Item ID that is used to download file contents.
Public property ItemType Gets the type of the item to change.
Public property Length Gets the length of the committed content (the version of the file the change is pended against).
Public property LocalItem Gets the path of the item on the local file system of the client.
Public propertyStatic member LocalItemComparer The comparer that compares local items.
Public property LocalOrServerFolder Gets the local folder if it is available. Otherwise, gets the server folder.
Public property LocalOrServerItem Gets the local path if it is available. Otherwise, gets the server path.
Public property LockLevel Gets the lock level of the item.
Public property LockLevelName Gets the localized name of the lock level.
Public property LockLevelShortName Gets the localized short name of the lock level.
Public property MergeSources Gets the read-only collection of MergeSources that is associated with this pending change.
Public property PendingChangeId Gets the ID that represents a unique value that is attached to the change.
Public property PropertyValues Gets the properties for this pending change.
Public property ServerItem Gets the server item that is being operated on.
Public propertyStatic member ServerItemComparer Gets the comparer that compares server items.
Public property SourceDeletionId Gets or sets the deletion ID of the source item.
Public property SourceLocalItem Gets the source local path or the item to be changed.
Public property SourceServerItem Gets the server path or the item to be changed.
Public property SourceVersionFrom Gets or sets the source version from.
Public property ToolTipText Gets the tooltip text for this pending change.
Public property Undone Gets a flag that describes whether this pending change has been undone.
Public property UploadHashValue Gets the MD5 HashValue for the file that is currently associated with this pending change.
Public property Version Gets the version of the pending change.
Public property VersionControlServer Gets the repository that contains this pending change.

Top

Methods

  Name Description
Public methodStatic member ConvertToChangeType Converts the ChangeType integer value that is returned from the server into a ChangeType enum.
Public methodStatic member ConvertToInt Converts the client ChangeType enum value to the integer value that is used by the server.
Public method DownloadBaseFile() Downloads the content of the version of the file against which the change was pended.
Public method DownloadBaseFile(String) Downloads the base version of the file upon which the change was pended.
Public method DownloadShelvedFile() Downloads the shelved content for this pending change. Throws if this is not a shelved pending change.
Public method DownloadShelvedFile(String) Downloads the shelved content for this pending change.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public methodStatic member GetLocalizedStringForChangeType(ChangeType) Creates a user-readable localized string for the change type.
Public methodStatic member GetLocalizedStringForChangeType(ChangeType, Boolean) Creates a user-readable localized string for the change type.
Public methodStatic member GetLocalizedStringForItemType Gets the localized string for the item type.
Public methodStatic member GetLocalizedStringForLockLevel Gets the localized string for the lock level.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public methodStatic member IsIEnumerableEmpty Checks to see whether an IEnumberable of PendingChange objects is empty.
Public methodStatic member IsSourceRename Checks whether the specified change type is a source rename and does not contain an add, branch, or rename.
Public methodStatic member MaterializeIEnumerable Converts an IEnumerable of PendingChange objects to an array of PendingChange objects.
Public method RestoreCandidateDelete Restores a candidate delete on disk, if it is a folder, walks children recursively and restores them also.
Public methodStatic member ToLocalItems Gets an array of local item paths from an array of pending changes.
Public methodStatic member ToServerItems Gets an array of server item paths from an array of pending changes.
Public method ToString Creates a user-readable string that describes a PendingChange object. (Overrides Object.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