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)

'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.

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

Top

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

Top

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