This documentation is archived and is not being maintained.

Shelveset Class

A server-side collection of pending changes and associated metadata.


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

Public NotInheritable Class Shelveset

The Shelveset type exposes the following members.

Public methodShelveset(VersionControlServer, String, String)Initializes a new Shelveset instance.
Public methodShelveset(VersionControlServer, String, String, IEnumerable(Of PropertyValue))Create a Shelveset object for shelving changes.

Public propertyArtifactUriArtifact Uri
Public propertyAssociatedWorkItemsReturns a limited set of information about the associated work items with this changeset. This property does not spin up a WorkItemStore. Therefore, it is very quick.
Public propertyBriefWorkItemInfoBrief work item information including only the Ids and the actions on each included with the shelveset. Unlike WorkItemInfo, this property does not access the server.
Public propertyChangesExcludedGets or sets a flag that describes whether some changes were excluded from this shelveset.
Public propertyCheckinNoteGets or sets the check-in note that is associated with this shelveset.
Public propertyCommentGets or sets the comment that describes the shelveset.
Public propertyCreationDateGets or sets the date and time that the shelveset was shelved.
Public propertyDisplayNameGets the formatted name of the shelveset.
Public propertyNameGets or sets the shelveset name.
Public propertyStatic memberNameComparerGets the comparer for names.
Public propertyOwnerDisplayNameThis is the owner of the shelveset in the display format.
Public propertyOwnerNameGets or sets the owner name.
Public propertyPolicyOverrideCommentGets or sets a user-supplied comment that describes why the policy failed.
Public propertyPropertiesReturns a read-only collection of properties associated with the shelveset.
Public propertyQualifiedNameThis is the formatted unique name of the shelveset.
Public propertyVersionControlServerGets the repository that contains this shelveset.
Public propertyWorkItemInfoGets or sets an array of the work items that are associated with the shelveset and their check-in behavior.

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 methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodRemovePropertyRemoves the property from the Properties bag.
Public methodSetPropertyAdds or updates the property value in the Properties bag.
Public methodToStringCreates a user-readable string that describes properties in this shelveset. (Overrides Object.ToString.)

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