WorkItemCollection Class

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

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)

public sealed class WorkItemCollection : ReadOnlyList

The WorkItemCollection type exposes the following members.

  NameDescription
Public propertyAsOfGets or sets the time that the query was executed in the local time zone.
Public propertyAsOfUTCGets or sets the time that the query was executed in UTC.
Public propertyCountGets the number of WorkItems in this collection. (Overrides ReadOnlyList.Count.)
Public propertyDefaultProjectHintGets or sets the Id of the Project to support in partial opening.
Public propertyDisplayFieldsGets a list of the WorkItemFieldDefinitions that will be paged from the server when a WorkItem in this collection is accessed.
Public propertyIsFixedSize Obsolete. (Inherited from ReadOnlyList.)
Public propertyIsReadOnly Obsolete. (Inherited from ReadOnlyList.)
Public propertyIsSynchronized Obsolete. (Inherited from ReadOnlyList.)
Public propertyItemGets the WorkItem in this collection at the specified index.
Public propertyPageSizeGets 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.
Public propertyQueryGets information about the query that resulted in this collection.
Public propertySortFieldsGets a list of the SortFields that are associated with this collection.
Public propertyStoreGets the WorkItemStore that is associated with this collection.
Public propertySyncRoot Obsolete. (Inherited from ReadOnlyList.)
Top

  NameDescription
Public methodContainsChecks whether the specified WorkItem occurs in this collection.
Public methodCopyTo Obsolete. (Inherited from ReadOnlyList.)
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetEnumerator (Inherited from ReadOnlyList.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIndexOf(Int32)Gets the index of the WorkItem that has the specified ID.
Public methodIndexOf(WorkItem)Gets the index of a WorkItem in this collection.
Public methodResortSorts this collection based on the current contents of the SortFields property.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIList.Add (Inherited from ReadOnlyList.)
Explicit interface implemetationPrivate methodIList.Clear (Inherited from ReadOnlyList.)
Explicit interface implemetationPrivate methodIList.Contains (Inherited from ReadOnlyList.)
Explicit interface implemetationPrivate methodICollection.CopyTo (Inherited from ReadOnlyList.)
Explicit interface implemetationPrivate propertyICollection.Count (Inherited from ReadOnlyList.)
Explicit interface implemetationPrivate methodIList.IndexOf (Inherited from ReadOnlyList.)
Explicit interface implemetationPrivate methodIList.Insert (Inherited from ReadOnlyList.)
Explicit interface implemetationPrivate propertyIList.IsFixedSize (Inherited from ReadOnlyList.)
Explicit interface implemetationPrivate propertyIList.IsReadOnly (Inherited from ReadOnlyList.)
Explicit interface implemetationPrivate propertyICollection.IsSynchronized (Inherited from ReadOnlyList.)
Explicit interface implemetationPrivate propertyIList.Item (Inherited from ReadOnlyList.)
Explicit interface implemetationPrivate methodIList.Remove (Inherited from ReadOnlyList.)
Explicit interface implemetationPrivate methodIList.RemoveAt (Inherited from ReadOnlyList.)
Explicit interface implemetationPrivate propertyICollection.SyncRoot (Inherited from ReadOnlyList.)
Top

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.

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: