Export (0) Print
Expand All

PendingChange Class

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

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

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

public ref class PendingChange sealed

The PendingChange type exposes the following members.

  NameDescription
Public propertyChangeTypeGets the ChangeType of this pending change.
Public propertyChangeTypeNameGets the localized name of the change type.
Public propertyConflictTypeGets the type of conflict against this change. This is only populated for queries against local workspaces.
Public propertyCreationDateGets the date that the change was pending.
Public propertyDeletionIdGets the ID of the item to be deleted.
Public propertyStatic memberEmptyIEnumerableGets an empty IEnumerable of PendingChanges.
Public propertyEncodingGets the encoding of the file.
Public propertyEncodingNameGets the localized name of the encoding.
Public propertyFileNameGets 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 propertyHashValueGets the MD5 HashValue for the contents of the pending change.
Public propertyIsAddGets a flag that describes whether this pending change is a pending add.
Public propertyIsBranchGets a flag that describes whether this change is a pending branch.
Public propertyIsCandidateGets a value that indicates whether the change is a candidate.
Public propertyIsDeleteGets a flag that describes whether this pending change is a pending delete.
Public propertyIsEditGets a flag that describes whether this pending change is a pending edit.
Public propertyIsEncodingGets a flag that describes whether this pending change is a pending file type change.
Public propertyIsImplicitGets a value that indicates whether this pending change represents change on the child item caused only by the parent change.
Public propertyIsLocalItemDeleteGets a flag that describes whether the pending change is deleting a local file or folder.
Public propertyIsLockGets a flag that describes whether this pending change has a lock.
Public propertyIsMergeGets a flag that describes whether this change is a pending merge.
Public propertyIsRenameGets a flag that describes whether this pending change is a pending rename.
Public propertyIsRollbackGets a flag that describes whether this change is a pending rollback.
Public propertyIsUndeleteGets a flag that describes whether this changes is a pending undelete.
Public propertyIsUnshelvedChangeGets a flag that describes whether this pending change is from unshelving a shelveset.
Public propertyItemIdGets the Item ID that is used to download file contents.
Public propertyItemTypeGets the type of the item to change.
Public propertyLengthGets the length of the committed content (the version of the file the change is pended against).
Public propertyLocalItemGets the path of the item on the local file system of the client.
Public propertyStatic memberLocalItemComparerThe comparer that compares local items.
Public propertyLocalOrServerFolderGets the local folder if it is available. Otherwise, gets the server folder.
Public propertyLocalOrServerItemGets the local path if it is available. Otherwise, gets the server path.
Public propertyLockLevelGets the lock level of the item.
Public propertyLockLevelNameGets the localized name of the lock level.
Public propertyLockLevelShortNameGets the localized short name of the lock level.
Public propertyMergeSourcesGets the read-only collection of MergeSources that is associated with this pending change.
Public propertyPendingChangeIdGets the ID that represents a unique value that is attached to the change.
Public propertyPropertyValuesGets the properties for this pending change.
Public propertyServerItemGets the server item that is being operated on.
Public propertyStatic memberServerItemComparerGets the comparer that compares server items.
Public propertySourceDeletionIdGets or sets the deletion ID of the source item.
Public propertySourceLocalItemGets the source local path or the item to be changed.
Public propertySourceServerItemGets the server path or the item to be changed.
Public propertySourceVersionFromGets or sets the source version from.
Public propertyToolTipTextGets the tooltip text for this pending change.
Public propertyUndoneGets a flag that describes whether this pending change has been undone.
Public propertyUploadHashValueGets the MD5 HashValue for the file that is currently associated with this pending change.
Public propertyVersionGets the version of the pending change.
Public propertyVersionControlServerGets the repository that contains this pending change.
Top

  NameDescription
Public methodStatic memberConvertToChangeTypeConverts the ChangeType integer value that is returned from the server into a ChangeType enum.
Public methodStatic memberConvertToIntConverts the client ChangeType enum value to the integer value that is used by the server.
Public methodDownloadBaseFile()Downloads the content of the version of the file against which the change was pended.
Public methodDownloadBaseFile(String)Downloads the base version of the file upon which the change was pended.
Public methodDownloadShelvedFile()Downloads the shelved content for this pending change. Throws if this is not a shelved pending change.
Public methodDownloadShelvedFile(String)Downloads the shelved content for this pending change.
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodStatic memberGetLocalizedStringForChangeType(ChangeType)Creates a user-readable localized string for the change type.
Public methodStatic memberGetLocalizedStringForChangeType(ChangeType, Boolean)Creates a user-readable localized string for the change type.
Public methodStatic memberGetLocalizedStringForItemTypeGets the localized string for the item type.
Public methodStatic memberGetLocalizedStringForLockLevelGets the localized string for the lock level.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodStatic memberIsIEnumerableEmptyChecks to see whether an IEnumberable of PendingChange objects is empty.
Public methodStatic memberIsSourceRenameChecks whether the specified change type is a source rename and does not contain an add, branch, or rename.
Public methodStatic memberMaterializeIEnumerableConverts an IEnumerable of PendingChange objects to an array of PendingChange objects.
Public methodRestoreCandidateDeleteRestores a candidate delete on disk, if it is a folder, walks children recursively and restores them also.
Public methodStatic memberToLocalItemsGets an array of local item paths from an array of pending changes.
Public methodStatic memberToServerItemsGets an array of server item paths from an array of pending changes.
Public methodToStringCreates a user-readable string that describes a PendingChange object. (Overrides Object::ToString().)
Top

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft