PendingChange Class

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
	ChangeType	Gets the ChangeType of this pending change.
	ChangeTypeName	Gets the localized name of the change type.
	CreationDate	Gets the date that the change was pending.
	DeletionId	Gets the ID of the item to be deleted.
	EmptyIEnumerable	Gets an empty IEnumerable of PendingChanges.
	Encoding	Gets the encoding of the file.
	EncodingName	Gets the localized name of the encoding.
	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.
	HashValue	Gets the MD5 HashValue for the contents of the pending change.
	IsAdd	Gets a flag that describes whether this pending change is a pending add.
	IsBranch	Gets a flag that describes whether this change is a pending branch.
	IsDelete	Gets a flag that describes whether this pending change is a pending delete.
	IsEdit	Gets a flag that describes whether this pending change is a pending edit.
	IsEncoding	Gets a flag that describes whether this pending change is a pending file type change.
	IsLocalItemDelete	Gets a flag that describes whether the pending change is deleting a local file or folder.
	IsLock	Gets a flag that describes whether this pending change has a lock.
	IsMerge	Gets a flag that describes whether this change is a pending merge.
	IsRename	Gets a flag that describes whether this pending change is a pending rename.
	IsRollback	Gets a flag that describes whether this change is a pending rollback.
	IsUndelete	Gets a flag that describes whether this changes is a pending undelete.
	IsUnshelvedChange	Gets a flag that describes whether this pending change is from unshelving a shelveset.
	ItemId	Gets the Item ID that is used to download file contents.
	ItemType	Gets the type of the item to change.
	LocalItem	Gets the path of the item on the local file system of the client.
	LocalItemComparer	The comparer that compares local items.
	LocalOrServerFolder	Gets the local folder if it is available. Otherwise, gets the server folder.
	LocalOrServerItem	Gets the local path if it is available. Otherwise, gets the server path.
	LockLevel	Gets the lock level of the item.
	LockLevelName	Gets the localized name of the lock level.
	LockLevelShortName	Gets the localized short name of the lock level.
	MergeSources	Gets the read-only collection of MergeSources that is associated with this pending change.
	PendingChangeId	Gets the ID that represents a unique value that is attached to the change.
	ServerItem	Gets the server item that is being operated on.
	ServerItemComparer	The comparer that compares server items.
	SourceDeletionId	Gets or sets the deletion ID of the source item.
	SourceLocalItem	Gets the source local path or the item to be changed.
	SourceServerItem	Gets the server path or the item to be changed.
	SourceVersionFrom	Gets or sets the source version from.
	ToolTipText	Gets the tooltip text for this pending change.
	Undone	Gets a flag that describes whether this pending change has been undone.
	UploadHashValue	Gets the MD5 HashValue for the file that is currently associated with this pending change.
	Version	Gets the version of the pending change.
	VersionControlServer	Gets the repository that contains this pending change.

Top

Methods

	Name	Description
	ConvertToChangeType	Converts the ChangeType integer value that is returned from the server into a ChangeType enum.
	ConvertToInt	Converts the client ChangeType enum value to the integer value that is used by the server.
	DownloadBaseFile	Downloads the base version of the file upon which the change was pended.
	DownloadShelvedFile	Downloads the shelved content for this pending change.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetLocalizedStringForChangeType(ChangeType)	Creates a user-readable localized string for the change type.
	GetLocalizedStringForChangeType(ChangeType, Boolean)	Creates a user-readable localized string for the change type.
	GetLocalizedStringForItemType	Gets the localized string for the item type.
	GetLocalizedStringForLockLevel	Gets the localized string for the lock level.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsIEnumerableEmpty	Checks to see if an IEnumberable of PendingChange objects is empty.
	IsSourceRename	Checks whether the specified change type is a source rename and does not contain an add, branch, or rename.
	MaterializeIEnumerable	Converts an IEnumerable of PendingChange objects to an array of PendingChange objects.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToLocalItems	Gets an array of local item paths from an array of pending changes.
	ToServerItems	Gets an array of server item paths from an array of pending changes.
	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