WorkItemCollection Class

Article
08/13/2012

Represents a collection of work items that result from a query to the WorkItemStore.

Inheritance Hierarchy

System.Object
Microsoft.TeamFoundation.WorkItemTracking.Common.ReadOnlyList
Microsoft.TeamFoundation.WorkItemTracking.Client.WorkItemCollection

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

Syntax

'Declaration
Public NotInheritable Class WorkItemCollection _
    Inherits ReadOnlyList

public sealed class WorkItemCollection : ReadOnlyList

public ref class WorkItemCollection sealed : public ReadOnlyList

[<Sealed>]
type WorkItemCollection =  
    class
        inherit ReadOnlyList
    end

public final class WorkItemCollection extends ReadOnlyList

The WorkItemCollection type exposes the following members.

Properties

	Name	Description
	AsOf	Gets or sets the time that the query was executed in the local time zone.
	AsOfUTC	Gets or sets the time that the query was executed in UTC.
	Count	Gets the number of WorkItems in this collection. (Overrides ReadOnlyList.Count.)
	DefaultProjectHint	Gets or sets the Id of the Project to support in partial opening.
	DisplayFields	Gets a list of the WorkItem FieldDefinitions that will be paged from the server when a WorkItem in this collection is accessed.
	IsFixedSize	Obsolete. (Inherited from ReadOnlyList.)
	IsReadOnly	Obsolete. (Inherited from ReadOnlyList.)
	IsSynchronized	Obsolete. (Inherited from ReadOnlyList.)
	Item	Gets the WorkItem in this collection at the specified index.
	PageSize	Gets or sets the number of WorkItems that this collection will keep in cache from the server when a WorkItem that has not been cached is accessed.
	Query	Gets information about the query that resulted in this collection.
	SortFields	Gets a list of the SortFields that are associated with this collection.
	Store	Gets the WorkItemStore that is associated with this collection.
	SyncRoot	Obsolete. (Inherited from ReadOnlyList.)

Top

Methods

	Name	Description
	Contains	Checks whether the specified WorkItem occurs in this collection.
	CopyTo	Obsolete. (Inherited from ReadOnlyList.)
	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.)
	GetEnumerator	(Inherited from ReadOnlyList.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetItem	(Inherited from ReadOnlyList.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IndexOf(Int32)	Gets the index of the WorkItem that has the specified ID.
	IndexOf(WorkItem)	Gets the index of a WorkItem in this collection.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Resort	Sorts this collection based on the current contents of the SortFields property.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

	Name	Description
	IList.Add	(Inherited from ReadOnlyList.)
	IList.Clear	(Inherited from ReadOnlyList.)
	IList.Contains	(Inherited from ReadOnlyList.)
	ICollection.CopyTo	(Inherited from ReadOnlyList.)
	ICollection.Count	(Inherited from ReadOnlyList.)
	IList.IndexOf	(Inherited from ReadOnlyList.)
	IList.Insert	(Inherited from ReadOnlyList.)
	IList.IsFixedSize	(Inherited from ReadOnlyList.)
	IList.IsReadOnly	(Inherited from ReadOnlyList.)
	ICollection.IsSynchronized	(Inherited from ReadOnlyList.)
	IList.Item	(Inherited from ReadOnlyList.)
	IList.Remove	(Inherited from ReadOnlyList.)
	IList.RemoveAt	(Inherited from ReadOnlyList.)
	ICollection.SyncRoot	(Inherited from ReadOnlyList.)

Top

Remarks

A WorkItemCollection is returned by methods such as WorkItemStore.Query(String). The properties of a WorkItemCollection contain information about the query that resulted in this particular collection:

The time that the query was executed.
The query string that resulted in this collection.

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.

Share via