Shelveset Class

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

Inheritance Hierarchy

System.Object
Microsoft.TeamFoundation.VersionControl.Client.Shelveset

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

Syntax

'Declaration
Public NotInheritable Class Shelveset
public sealed class Shelveset
public ref class Shelveset sealed
[<Sealed>]
type Shelveset =  class end
public final class Shelveset

The Shelveset type exposes the following members.

Constructors

Name Description
Public method Shelveset(VersionControlServer, String, String) Initializes a new Shelveset instance.
Public method Shelveset(VersionControlServer, String, String, IEnumerable<PropertyValue>) Create a Shelveset object for shelving changes.

Top

Properties

Name Description
Public property ArtifactUri Artifact Uri
Public property AssociatedWorkItems Returns 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 property BriefWorkItemInfo Brief 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 property ChangesExcluded Gets or sets a flag that describes whether some changes were excluded from this shelveset.
Public property CheckinNote Gets or sets the check-in note that is associated with this shelveset.
Public property Comment Gets or sets the comment that describes the shelveset.
Public property CreationDate Gets or sets the date and time that the shelveset was shelved.
Public property DisplayName Gets the formatted name of the shelveset.
Public property Name Gets or sets the shelveset name.
Public propertyStatic member NameComparer Gets the comparer for names.
Public property OwnerDisplayName This is the owner of the shelveset in the display format.
Public property OwnerName Gets or sets the owner name.
Public property PolicyOverrideComment Gets or sets a user-supplied comment that describes why the policy failed.
Public property Properties Returns a read-only collection of properties associated with the shelveset.
Public property QualifiedName This is the formatted unique name of the shelveset.
Public property VersionControlServer Gets the repository that contains this shelveset.
Public property WorkItemInfo Gets or sets an array of the work items that are associated with the shelveset and their check-in behavior.

Top

Methods

Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method RemoveProperty Removes the property from the Properties bag.
Public method SetProperty Adds or updates the property value in the Properties bag.
Public method ToString Creates a user-readable string that describes properties in this shelveset. (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